mp-units/doc/INSTALL.md

Installation and Reuse

There are a few different ways of installing/reusing units in your project.

Copy

As units is a header-only library you can simply copy src/include directory to your source tree and use it as regular header files.

NOTE: Until C++20 arrives the library has some 3rd party dependencies that provide experimental C++20 features. They can be easily obtained with conan

requires = (
    "cmcstl2/2019.03.18@mpusz/stable",
    "gsl-lite/0.33.0@nonstd-lite/stable"
)

cmake + conan

To use units as a cmake imported library via cmake configuration files the following steps may be done:

• add the following remotes to your local conan instance

  $ conan remote add conan-mpusz https://api.bintray.com/conan/mpusz/conan-mpusz
  $ conan remote add conan-nonstd https://api.bintray.com/conan/martinmoene/nonstd-lite
  

• add units as a dependency to your conan file

  • conanfile.txt

    [requires]
    mp-units/0.0.1@mpusz/testing
    

  • conanfile.py

    requires = "mp-units/0.0.1@mpusz/testing"
    

• link your cmake target with units

  target_link_libraries(<your_target> PUBLIC|PRIVATE|INTERFACE CONAN_PKG::mp-units)
  

• install conan dependencies before configuring cmake

  $ cd build
  $ conan install .. -pr <your_conan_profile> -s cppstd=20 -b=outdated -u
  

Full build and unit testing

In case you would like to build all the code in that repository (with unit tests and examples) you should use CMakeLists.txt from the parent directory.

mkdir build && cd build
conan install .. <your_profile_and_settings> -s cppstd=20
cmake .. <your_cmake_configuration>
cmake --build .

Packaging

To create a conan package and test cmake installation and conan packaging run:

$ conan create . <username>/<channel> -s cppstd=20 -b=outdated <your_profile_and_settings>

Upload package to conan server

$ conan upload -r <remote-name> --all mp-units/0.0.1@<user>/<channel>