-
Notifications
You must be signed in to change notification settings - Fork 57
Update Windows README + gitignore test executable #29
Update Windows README + gitignore test executable #29
Conversation
.gitignore
Outdated
ElectionGuardConfig.cmake | ||
simple.exe |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good addition!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👉 hide whole simple
folder
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Leaving review up to @echumley-msft , but left comments to help along.
cmake -G "MSYS Makefiles" .. | ||
make | ||
cmake -S . -B build -G "MSYS Makefiles" .. | ||
cmake --build build |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good addition, the original commands were using an older version of cmake and building with make
.
The newer version allows for autocreation of the folder.
|
||
3. You should now have a `libelectionguard.a`. | ||
3. You should now have a `electionguard.a` or `electionguard.dll` (depending on the how cmake was configured). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The commands listed in Step 2 should only build an artifact (.a
).
It would only build a .dll if -DBUILD_SHARED_LIBS=ON
is passed with command.
cmake -G "MSYS Makefiles" .. | ||
make | ||
cmake -S examples/simple -B simple_build -G "MSYS Makefiles" | ||
cmake --build simple_build --target simple |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good improvement.
Checklist
🚨Please review the guidelines for contributing to this repository.
Description
Updated documentation to run on Windows. If CMAKE was never previously installed on the Windows machine (either from pacman inside of MSYS or in the Windows side from cmake.org), then using the cmake commands with
-G "MSYS Makefiles"
will fail withError: Could not create named generator MSYS Makefiles
. This adds that package to be installed via pacman during the initial setup of MSYS2. This also updates the cmake command's arguments to specify the source and build directories from the root of the project and run make through cmake for consistency. This PR also gitignores thesimple.exe
that is generated from by the example build.