changed cmake instructiosn

Author: amock

docs/extra/cmake_advanced.md

@@ -9,9 +9,9 @@ add_compile_options(-std=c++17)
 set(CMAKE_CXX_STANDARD 17)
 
 # find components of a specific rmagine version
-# '2.2.1...' will get the newest rmagine which 
-# is greater than 2.2.1
-find_package(rmagine 2.2.1... 
+# '2.2.8' will get the newest rmagine which 
+# is greater equal 2.2.8
+find_package(rmagine 2.2.8
   COMPONENTS
     core 
     embree
@@ -27,6 +27,49 @@ target_link_libraries(my_rmagine_app
 )
 ```
 
+## CMake - Optional Components
+
+```cmake
+add_compile_options(-std=c++17)
+set(CMAKE_CXX_STANDARD 17)
+
+# find components of a specific rmagine version
+# '2.2.8' will get the newest rmagine which 
+# is greater equal 2.2.8
+find_package(rmagine 2.2.8
+    COMPONENTS
+        core
+    OPTIONAL_COMPONENTS
+        embree
+        cuda
+        optix
+)
+
+if(TARGET rmagine::embree)
+    # Compile app with embree support,
+    # if rmagine::embree was found
+    add_executable(my_rmagine_embree_app 
+        src/my_rmagine_embree_app.cpp)
+    target_link_libraries(my_rmagine_embree_app
+        rmagine::core
+        rmagine::embree
+    )
+endif(TARGET rmagine::embree)
+
+if(TARGET rmagine::optix)
+    # Compile app with optix support,
+    # if rmagine::optix was found
+    add_executable(my_rmagine_optix_app 
+        src/my_rmagine_optix_app.cpp)
+    target_link_libraries(my_rmagine_optix_app
+        rmagine::core
+        rmagine::cuda
+        rmagine::optix
+    )
+endif(TARGET rmagine::optix)
+```
+
+
 ## CMake - FetchContent
 
 Rmagine is compatible with CMake's FetchContent functionality. The following `CMakeListst.txt` shows how to use `FetchContent` and checks if the required targets have been built successfully.
@@ -39,24 +82,22 @@ add_compile_options(-std=c++17)
 set(CMAKE_CXX_STANDARD 17)
 
 include(FetchContent)
-
 set(FETCHCONTENT_QUIET FALSE)
-
 FetchContent_Declare(
   rmagine
   GIT_REPOSITORY https://github.com/uos/rmagine.git
   GIT_TAG        v2.2.9 # put 'main' here for latest
   GIT_PROGRESS   TRUE
 )
-
 FetchContent_MakeAvailable(rmagine)
 
 if(NOT TARGET rmagine::embree)
     message(FATAL "Could not build rmagine's embree backand which is required for this executable")
 endif(NOT TARGET rmagine::embree)
 
-add_executable(my_rmagine_app src/my_rmagine_app.cpp)
-target_link_libraries(my_rmagine_app
+add_executable(my_rmagine_embree_app
+    src/my_rmagine_embree_app.cpp)
+target_link_libraries(my_rmagine_embree_app
     rmagine::core
     rmagine::embree)
 ```

docs/installation.md

@@ -20,7 +20,7 @@ Rmagine provides an interface to integrate ray tracing libraries, we call backbo
 
 ### Embree Backbone (optional)
 
-We support Embree in its latest version (test v4.0.1, v4.2.0):
+We support Embree in its latest version (tested: v4.0.1, v4.2.0):
 
 ```bash
 user@pc:~$ git clone https://github.com/embree/embree.git
@@ -34,7 +34,7 @@ For older Embree versions we refer to [this](/extra/embree3.md).
 
 ### OptiX Backbone (optional)
 
-Rmagine supports NVIDIA OptiX versions of 7.2 or newer.
+Rmagine supports NVIDIA OptiX versions of 7.2 or newer (experimental support for OptiX 8).
 The OptiX-Library is installed via the GPU driver.
 The OptiX-Headers can be downloaded [here](https://developer.nvidia.com/designworks/optix/download).
 The Headers require a specific GPU driver and CUDA version to be installed on your system:
@@ -48,7 +48,6 @@ The Headers require a specific GPU driver and CUDA version to be installed on yo
 |     7.6       |  520.00 (untested)     |
 |     7.7       |  530.41                |
 
-
 ## Compilation
 
 Download the Rmagine repository. 

docs/integration.md

@@ -21,7 +21,6 @@ int main(int argc, char** argv)
     sim.setMap(map);
 
     // go on (see workflow section)
-
     return 0;
 }
 ```
@@ -35,9 +34,9 @@ add_compile_options(-std=c++17)
 set(CMAKE_CXX_STANDARD 17)
 
 # find components of a specific rmagine version
-# '2.2.1...' will get the newest rmagine which 
-# is greater than 2.2.1
-find_package(rmagine 2.2.1... 
+# '2.2.8' will get the newest rmagine which 
+# is greater equal 2.2.8
+find_package(rmagine 2.2.8
   COMPONENTS
     core 
     embree
@@ -72,7 +71,6 @@ int main(int argc, char** argv)
     sim.setMap(map);
 
     // go on (see workflow section)
-
     return 0;
 }
 
@@ -87,9 +85,9 @@ add_compile_options(-std=c++17)
 set(CMAKE_CXX_STANDARD 17)
 
 # find components of a specific rmagine version
-# '2.2.1...' will get the newest rmagine which 
-# is greater than 2.2.1
-find_package(rmagine 2.2.1... 
+# '2.2.8' will get the newest rmagine which 
+# is greater equal 2.2.8
+find_package(rmagine 2.2.8 
   COMPONENTS
     core 
     cuda
@@ -107,5 +105,4 @@ target_link_libraries(my_rmagine_app
 )
 ```
 
-
 For more details and alternate ways of integrating Rmagine into your CMake project we refer to: [CMake - Advanced](/extra/cmake_advanced.md).