From 1b8a216ddf1a3bb612958b912bce5121372dd2e2 Mon Sep 17 00:00:00 2001 From: Victor Zverovich Date: Fri, 28 Dec 2018 15:05:42 -0800 Subject: [PATCH] Improve docs --- doc/CMakeLists.txt | 2 +- doc/usage.rst | 10 ++++++++-- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index c16427a9..f3dae606 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -6,7 +6,7 @@ endif () add_custom_target(doc COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/build.py ${FMT_VERSION} - SOURCES api.rst syntax.rst build.py conf.py _templates/layout.html) + SOURCES api.rst syntax.rst usage.rst build.py conf.py _templates/layout.html) install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/ DESTINATION share/doc/fmt OPTIONAL) diff --git a/doc/usage.rst b/doc/usage.rst index 2b9777c6..29b2cbc6 100644 --- a/doc/usage.rst +++ b/doc/usage.rst @@ -58,8 +58,14 @@ To build a `shared library`__ set the ``BUILD_SHARED_LIBS`` CMake variable to __ http://en.wikipedia.org/wiki/Library_%28computing%29#Shared_libraries -Header-only usage with CMake -============================ +Installing the library +==================== + +After building the library you can install it on a Unix-like system by running +:command:`sudo make install`. + +Usage with CMake +================ You can add the ``fmt`` library directory into your project and include it in your ``CMakeLists.txt`` file::