From 9efa8b471104e98be797b3387645c3599eea06f8 Mon Sep 17 00:00:00 2001 From: Mateusz Pusz Date: Thu, 5 Nov 2020 17:51:04 +0100 Subject: [PATCH] docs: `conan build ..` added to usage --- docs/usage.rst | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/usage.rst b/docs/usage.rst index f8548450..c03aaefc 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -353,13 +353,18 @@ in **mp-units** repository, you should: pip3 install -r docs/requirements.txt mkdir build && cd build conan install .. -pr -s compiler.cppstd=20 -e mp-units:CONAN_RUN_TESTS=True -b outdated -u + conan build .. + +The above will download and install all of the dependencies needed for the development of the library, +build all of the source code and documentation, and run unit tests. Instead of the last ``conan build ..`` step you can +also do the following: + +.. code-block:: shell + cmake .. -DCMAKE_BUILD_TYPE=Release cmake --build . ctest -The above will download and install all of the dependencies needed for the development of the library, -build all of the source code and documentation, and run unit tests. - Packaging ---------