Build examples as an option (#30)

* build: add option for enabling examples to be built

* chore: formatting

* docs: add generation for building examples

* chore: formatting

* on push

* build: add option for enabling examples to be built

* chore: formatting

* docs: add generation for building examples

* chore: formatting

Co-authored-by: darife <darife@jlg.com>
Co-authored-by: Erik Erlandson <eerlands@redhat.com>

CMakeLists.txt

@@ -1,6 +1,7 @@
 cmake_minimum_required(VERSION 3.0)
 project(st_tree VERSION 1.0.6)
 
+option(BUILD_EXAMPLES "Build the examples." OFF)
 option(ENABLE_TESTS "Enable the tests. Requires boost." ON)
 
 include(GNUInstallDirs)
@@ -15,7 +16,9 @@ ENDIF()
 add_subdirectory(include)
 
 # tutorial examples
-add_subdirectory(examples)
+if(BUILD_EXAMPLES)
+    add_subdirectory(examples)
+endif()
 
 # testing programs
 if(ENABLE_TESTS)

README.md

@@ -51,6 +51,10 @@ Quick start:
 $ cd /path/to/st_tree
 $ cmake .
 
+# generate makefiles to build examples from cmake
+$ cd /path/to/st_tree
+$ cmake . -DBUILD_EXAMPLES=ON
+
 # make examples and tests:
 $ make