From 0440934c65f291d10253aca274f52252d241f8cf Mon Sep 17 00:00:00 2001 From: bielow Date: Mon, 21 Nov 2022 22:33:21 +0100 Subject: [PATCH] add docs on how to build the docs :) --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index b8943c1..1274a41 100644 --- a/README.md +++ b/README.md @@ -193,6 +193,17 @@ cmake --build . ctest --output-on-failure ``` +#### Building the Doxygen/html documentation + +Make sure you have Dogygen installed and configure CMake using the `SQLITECPP_RUN_DOXYGEN=ON` flag: + +``` +cmake -DSQLITECPP_RUN_DOXYGEN=ON +``` + +and then execute the `SQLiteCpp_doxygen` target (or build all targets, see above). +The documentation will be generated in the 'doc' subfolder of the source tree. + #### CMake options * For more options on customizing the build, see the [CMakeLists.txt](https://github.com/SRombauts/SQLiteCpp/blob/master/CMakeLists.txt) file.