mpusz/mp-units
1
0
Fork 1
mirror of https://github.com/mpusz/mp-units.git synced 2025-08-02 20:04:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: "Install" chapter added to Usage

Browse Source
This commit is contained in:
Mateusz Pusz
2021-05-09 19:30:27 +02:00
parent 2c8c6c2e98
commit c028f606c8
1 changed files with 18 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/usage.rst
View File

@@ -278,7 +278,7 @@ library release the following steps may be performed:
.. code-block:: shell .. code-block:: shell
mkdir build && cd build mkdir my_project/build && cd my_project/build
conan install .. -pr <your_conan_profile> -s compiler.cppstd=20 -b=missing conan install .. -pr <your_conan_profile> -s compiler.cppstd=20 -b=missing
cmake .. -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake cmake .. -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake
cmake --build . cmake --build .
@@ -329,12 +329,27 @@ differences:
.. code-block:: shell .. code-block:: shell
mkdir build && cd build mkdir my_project/build && cd my_project/build
conan install .. -pr <your_conan_profile> -s compiler.cppstd=20 -b=outdated -u conan install .. -pr <your_conan_profile> -s compiler.cppstd=20 -b=outdated -u
cmake .. -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake cmake .. -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake
cmake --build . cmake --build .
Install
^^^^^^^
In case you don't want to use Conan in your project and just want to install the **mp-units**
library on your file system and use it via ``find_package(mp-units)`` from another repository
to find it, it is enough to perform the following steps:
.. code-block:: shell
mkdir units/build && cd units/build
conan install .. -pr <your_conan_profile> -s compiler.cppstd=20 -b=missing
cmake ../src -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake
cmake --install . --prefix <install_dir>
Contributing (or just building all the tests, examples, and documentation) Contributing (or just building all the tests, examples, and documentation)
-------------------------------------------------------------------------- --------------------------------------------------------------------------
@@ -351,7 +366,7 @@ in **mp-units** repository, you should:
conan remote add linear-algebra https://twonington.jfrog.io/artifactory/api/conan/conan-oss conan remote add linear-algebra https://twonington.jfrog.io/artifactory/api/conan/conan-oss
git clone https://github.com/mpusz/units.git && cd units git clone https://github.com/mpusz/units.git && cd units
pip3 install -r docs/requirements.txt pip3 install -r docs/requirements.txt
mkdir build && cd build mkdir units/build && cd units/build
conan install .. -pr <your_conan_profile> -s compiler.cppstd=20 -e mp-units:CONAN_RUN_TESTS=True -b outdated -u conan install .. -pr <your_conan_profile> -s compiler.cppstd=20 -e mp-units:CONAN_RUN_TESTS=True -b outdated -u
conan build .. conan build ..