From ae79883f482ce563cf2d8fa8d5678fff0db19dba Mon Sep 17 00:00:00 2001 From: Jordan Williams Date: Fri, 10 Jan 2020 13:14:55 -0600 Subject: [PATCH] add documentation for installation components --- doc/usage.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/usage.rst b/doc/usage.rst index dacb4f03..55c7bcd3 100644 --- a/doc/usage.rst +++ b/doc/usage.rst @@ -58,6 +58,21 @@ Installing the Library After building the library you can install it on a Unix-like system by running :command:`sudo make install`. +The installation can be broken up into specific sub-components, if desired. +The library provides the following components: + +* ``FMT_Runtime`` - the shared library +* ``FMT_Development`` - the static library, headers, and package configuration files +* ``FMT_Documentation`` - the html documentation + +As an example, the shared library can be selectively installed by running:: + + cmake -DCOMPONENT=FMT_Runtime -P cmake_install.cmake + +If using CMake 3.15 or later, then the CMake install command can be used instead:: + + cmake --install . --component FMT_Runtime + Usage with CMake ================