Skip to content

Commit

Permalink
Update README.md (#193)
Browse files Browse the repository at this point in the history
Change `Quickstart` section to match new default value for testing.
  • Loading branch information
gchatelet authored Oct 27, 2021
1 parent 8e5c298 commit 0dd8b41
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,21 +194,25 @@ See [LICENSE](LICENSE) for more information.
Please check the [CMake build instructions](cmake/README.md).

<a name="quickstart"></a>
### Quickstart with `Ninja`
### Quickstart

- build `list_cpu_features`
```
cmake -B/tmp/cpu_features -H. -GNinja -DCMAKE_BUILD_TYPE=Release
ninja -C/tmp/cpu_features
/tmp/cpu_features/list_cpu_features --json
- Run `list_cpu_features`
```sh
cmake -S. -Bbuild -DBUILD_TESTING=OFF -DCMAKE_BUILD_TYPE=Release
cmake --build build --config Release -j
./build/list_cpu_features --json
```

_Note_: Use `--target ALL_BUILD` on the second line for `Visual Studio` and `XCode`.

- run tests
```sh
cmake -S. -Bbuild -DBUILD_TESTING=ON -DCMAKE_BUILD_TYPE=Debug
cmake --build build --config Debug -j
cmake --build build --config Debug --target test
```
cmake -B/tmp/cpu_features -H. -GNinja -DBUILD_TESTING=ON
ninja -C/tmp/cpu_features
ninja -C/tmp/cpu_features test
```

_Note_: Use `--target RUN_TESTS` on the last line for `Visual Studio` and `--target RUN_TEST` for `XCode`.

<a name="bindings"></a>
## Community bindings
Expand Down

0 comments on commit 0dd8b41

Please sign in to comment.