aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGuillaume Chatelet <gchatelet@google.com>2020-09-21 09:46:12 +0000
committerGuillaume Chatelet <gchatelet@google.com>2020-09-21 09:46:12 +0000
commit3dc868037a89d2741b0fa6ca1add1966b156eaa0 (patch)
tree40b93bbfb1e54975afb00a4145a2cf4baf35b010
parent33bd72c1bcf080e8d9cf48403e0ebcbb8bf5ab5a (diff)
downloadplatform_external_cpu_features-3dc868037a89d2741b0fa6ca1add1966b156eaa0.tar.gz
platform_external_cpu_features-3dc868037a89d2741b0fa6ca1add1966b156eaa0.tar.bz2
platform_external_cpu_features-3dc868037a89d2741b0fa6ca1add1966b156eaa0.zip
Add quickstart to documentation
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 29d7946..f67f339 100644
--- a/README.md
+++ b/README.md
@@ -172,3 +172,20 @@ See [LICENSE](LICENSE) for more information.
## Build with CMake
Please check the [CMake build instructions](cmake/README.md).
+
+### Quickstart with `Ninja`
+
+ - 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 tests
+```
+ cmake -B/tmp/cpu_features -H. -GNinja -DBUILD_TESTING=ON
+ ninja -C/tmp/cpu_features
+ ninja -C/tmp/cpu_features test
+
+```