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:
authorMizux <corentinl@google.com>2022-04-27 18:08:04 +0300
committerGitHub <noreply@github.com>2022-04-27 18:08:04 +0300
commit0bf4ea05294061560a0f84fa39af4db66b91b943 (patch)
tree548eb25a873c889ca14505515a7ff7f319651a7d
parentb04a9daf7121a6c7e8d046a372fdc194ed2728a0 (diff)
Add install doc (Fix #238) (#239)
-rw-r--r--README.md50
-rw-r--r--cmake/README.md2
-rw-r--r--cmake/ci/vagrant/freebsd/Vagrantfile5
3 files changed, 39 insertions, 18 deletions
diff --git a/README.md b/README.md
index c581f46..3e6a16b 100644
--- a/README.md
+++ b/README.md
@@ -216,23 +216,39 @@ Please check the [CMake build instructions](cmake/README.md).
<a name="quickstart"></a>
### Quickstart
- - 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
-```
-
-_Note_: Use `--target RUN_TESTS` on the last line for `Visual Studio` and `--target RUN_TEST` for `XCode`.
+- 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
+ ```
+
+ _Note_: Use `--target RUN_TESTS` on the last line for `Visual Studio` and `--target RUN_TEST` for `XCode`.
+
+
+- install `cpu_features`
+ ```sh
+ cmake --build build --config Release --target install -v
+ ```
+
+ _Note_: Use `--target INSTALL` for `Visual Studio`.
+
+ _Note_: When using `Makefile` or `XCode` generator, you can use
+ [`DESTDIR`](https://www.gnu.org/software/make/manual/html_node/DESTDIR.html)
+ to install on a local repository.<br>
+ e.g.
+ ```sh
+ cmake --build build --config Release --target install -v -- DESTDIR=install
+ ```
<a name="bindings"></a>
## Community bindings
diff --git a/cmake/README.md b/cmake/README.md
index b2d96c4..de33b23 100644
--- a/cmake/README.md
+++ b/cmake/README.md
@@ -17,7 +17,7 @@ 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.
-3- Add the `cpu_features` target to the `target_link_libraries()` section of
+3- Add the `CpuFeature::cpu_features` target to the `target_link_libraries()` section of
your executable or of your library.
## Disabling tests
diff --git a/cmake/ci/vagrant/freebsd/Vagrantfile b/cmake/ci/vagrant/freebsd/Vagrantfile
index 421dc88..6234ff6 100644
--- a/cmake/ci/vagrant/freebsd/Vagrantfile
+++ b/cmake/ci/vagrant/freebsd/Vagrantfile
@@ -99,4 +99,9 @@ Vagrant.configure("2") do |config|
cd project
cmake --build build --target test -v
SHELL
+ config.vm.provision "test", type: "shell", inline:<<-SHELL
+ set -x
+ cd project
+ cmake --build build --target install -v
+ SHELL
end