summaryrefslogtreecommitdiff
path: root/Install.txt
diff options
context:
space:
mode:
authorAllen Winter <allen.winter@kdab.com>2018-01-21 12:44:56 -0500
committerAllen Winter <allen.winter@kdab.com>2018-01-21 12:44:56 -0500
commitbf9e0b3c7909f316e8b33b12e21ccda6c6d9681f (patch)
tree811a31c74373d0704fab0ce5fb44256a82909427 /Install.txt
parent31586f528c03d27e512b715be21166cacf1d61ff (diff)
downloadlibical-git-bf9e0b3c7909f316e8b33b12e21ccda6c6d9681f.tar.gz
CMakeLists.txt, docs/CMakeLists.txt, Install.txt - new CMake option ICAL_BUILD_DOCS
Diffstat (limited to 'Install.txt')
-rw-r--r--Install.txt4
1 files changed, 4 insertions, 0 deletions
diff --git a/Install.txt b/Install.txt
index 9b8e0141..1ba87063 100644
--- a/Install.txt
+++ b/Install.txt
@@ -134,3 +134,7 @@ You can override various installation folders by passing the following variables
CMAKE_INSTALL_DATAROOTDIR = The fullpath where to want to put the shared files
for example: cmake -DCMAKE_INSTALL_PREFIX=/opt -DCMAKE_INSTALL_LIBDIR=/opt/lib32 ..
+
+== Build the documentation ==
+Run 'make docs' to build the API documentation and reference.
+Disable the docs make target by running CMake with -DICAL_BUILD_DOCS=False option.