Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions in README to build on Windows #38

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add instructions in README to build on Windows #38

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d5656bc
Added what arnavb suggested on april 18th. As well as I will be submi…
lovjs Oct 30, 2018
0bca4c3
Made it so the code is now in a code block!
lovjs Oct 30, 2018
c473484
Fixed some typos!
lovjs Oct 30, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,19 @@ On Linux and macOS, you can compile and run the tests using the command line.
Then you can simply select which target (unit test) you want to build/run, and
your IDE will do the rest.

For example in visual studio you might run these commands:
```
mkdir build && cd build
cmake -D<options> -G<VS Generator> ..
cmake --build . --config <configuration> # Default build
cmake --build . --target <target> --config <configuration> # Other targets, such as
# coverage or test. For testing, ctest is a better option.
```
* `<options>` are any options you pass to CMake (except CMAKE_BUILD_TYPE which doesn't work for multi-config generators anyways).
* `<VS Generator>` is a visual studio generator such as those listed here.
* `<configuration>` needs to be a valid CMake configuration (Debug, Release, DebWithRelInfo, MinSizeRel). If it is excluded, the default configuration is (usually) Debug.
* `<target>` can be any build target. Eg for any target make `<target>`, you have to pass --target `<target>` to cmake --build.

In case your IDE does not support CMake directly, you will need to run `cmake`
via the command line with the appropriate flags to generate the project files
for your IDE. Give it a try, it's not supposed to be hard!
Expand Down