Update README and CMakeLists with compilation informations

mtouzot · Dec 1, 2023 · d67d03d · d67d03d
1 parent 3d76516
commit d67d03d
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -142,7 +142,7 @@ endif(BUILD_EXAMPLES)
 # Doxygen config
 #------------------------------------------------------------
 
-option(BUILD_DOCS "Build documentation" ON)
+option(BUILD_DOCS "Build documentation" OFF)
 
 if(BUILD_DOCS)
     # Check if Doxygen is installed

diff --git a/README.md b/README.md
@@ -25,6 +25,16 @@ Image taken with a Lytro Illum by Doodybutch, published under [CC BY-SA 4.0 lice
 
 Image taken with a Lytro camera animated by [Christopher Hahne](http://www.christopherhahne.de/), published under [GNU General Public License version 3 license](https://opensource.org/license/gpl-3-0) for his [PlenoptiCam](https://github.com/hahnec/plenopticam) software.
 
+# Compilation
+
+Here are the commands to compile this project :
+```console
+cd <lytroio_build_directory>
+cmake -G <cmake_generator> -DBUILD_EXAMPLES=<ON/OFF> -DBUILD_DOCS=<ON/OFF> <lytroio_source_directory>
+cmake --build . --config <cfg>
+```
+By default, **BUILD_EXAMPLES** and **BUILD_DOCS** are set to **OFF**.
+
 # External ressources
 
 Here is some further reading or other projects :