From 0dd8b41eca0288bd0e5b493adcdaf7a46b80b94b Mon Sep 17 00:00:00 2001 From: Guillaume Chatelet Date: Wed, 27 Oct 2021 14:48:47 +0200 Subject: [PATCH] Update README.md (#193) Change `Quickstart` section to match new default value for testing. --- README.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 6c7ee22..48f9caa 100644 --- a/README.md +++ b/README.md @@ -194,21 +194,25 @@ See [LICENSE](LICENSE) for more information. Please check the [CMake build instructions](cmake/README.md). -### 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`. ## Community bindings