Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/google/cpu_features.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCorentin Le Molgat <corentinl@google.com>2021-10-27 11:52:52 +0300
committerMizux <mizux.dev@gmail.com>2021-10-27 14:24:05 +0300
commit8e5c298d1df85dc9b48791b62ab231a3aed952d0 (patch)
treeda6db6dfd48cbf33a84baa06a7e526db51cc0aa0
parent06abc90b455ab030d81b64a1c050f153e2ed39dc (diff)
Update README.md
-rw-r--r--cmake/README.md32
1 files changed, 17 insertions, 15 deletions
diff --git a/cmake/README.md b/cmake/README.md
index a2878cd..495b838 100644
--- a/cmake/README.md
+++ b/cmake/README.md
@@ -2,27 +2,29 @@
## Recommended usage : Incorporating cpu_features into a CMake project
- For API / ABI compatibility reasons, it is recommended to build and use
- cpu_features in a subdirectory of your project or as an embedded dependency.
+For API / ABI compatibility reasons, it is recommended to build and use
+cpu_features in a subdirectory of your project or as an embedded dependency.
- This is similar to the recommended usage of the googletest framework
- ( https://github.com/google/googletest/blob/master/googletest/README.md )
+This is similar to the recommended usage of the googletest framework
+( https://github.com/google/googletest/blob/master/googletest/README.md )
- Build and use step-by-step
+Build and use step-by-step
- 1- Download cpu_features and copy it in a sub-directory in your project.
- or add cpu_features as a git-submodule in your project
+1- Download cpu_features and copy it in a sub-directory in your project.
+or add cpu_features as a git-submodule in your project
- 2- You can then use the cmake command `add_subdirectory()` to include
- cpu_features directly and use the `cpu_features` target in your project.
+2- You can then use the cmake command `add_subdirectory()` to include
+cpu_features directly and use the `cpu_features` target in your project.
- 3- Add the `cpu_features` target to the `target_link_libraries()` section of
- your executable or of your library.
+3- Add the `cpu_features` target to the `target_link_libraries()` section of
+your executable or of your library.
## Disabling tests
- CMake default options for cpu_features is Release built type with tests
- enabled. To disable testing set cmake `BUILD_TESTING` variable to `OFF`,
- [.travis.yml](../.travis.yml) and [appveyor.yml](../appveyor.yml) have up to
- date examples.
+CMake default options for cpu_features is `Release` built type with tests
+enabled. To disable testing set cmake `BUILD_TESTING` variable to `OFF`.
+e.g.
+```sh
+cmake -S. -Bbuild -DBUILD_TESTING=OFF
+```