added fetch content example

amock · amock · commit abe11c5fe328 · 2024-11-24T13:13:57.000+01:00
diff --git a/docs/extra/cmake_advanced.md b/docs/extra/cmake_advanced.md
@@ -0,0 +1,62 @@
+# CMake - Advanced
+
+## CMake - Standard
+
+The standard way of including Rmagine is by first installing it and then importing it to another project via CMake's `find_package` command as follows:
+
+```cmake
+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... 
+  COMPONENTS
+    core 
+    embree
+)
+
+add_executable(my_rmagine_app 
+    src/my_rmagine_app.cpp)
+
+# link against rmagine targets
+target_link_libraries(my_rmagine_app
+    rmagine::core
+    rmagine::embree
+)
+```
+
+## 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.
+
+```cmake
+cmake_minimum_required(VERSION 3.16)
+project(my_rmagine_app)
+
+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
+    rmagine::core
+    rmagine::embree)
+```
diff --git a/docs/getting_started/integration.md b/docs/getting_started/integration.md
@@ -105,4 +105,7 @@ target_link_libraries(my_rmagine_app
     rmagine::cuda
     rmagine::optix
 )
-```
+```
+
+
+For more details and alternate ways of integrating Rmagine into your CMake project we refer to: [CMake - Advanced](/extra/cmake_advanced.md).
diff --git a/docs/getting_started/simulation.md b/docs/getting_started/simulation.md
@@ -97,4 +97,6 @@ auto ranges5 = result.ranges(5 * model.size(), 6 * model.size());
 std::cout << "printing the first ray's range of the fifth scan: " << ranges5[0] << std::endl;
 
 // slicing and other useful operations will be described at another Wiki page.
-```
+```
+
+## TODO: Explain TF a bit
diff --git a/docs/index.md b/docs/index.md
@@ -43,9 +43,10 @@ When using the Rmagine library or any related ideas in your scientific work, ple
 
 - [Tools](extra/tools)
 - [Data](extra/data)
-- [News](extra/news)
 - [Embree 3](extra/embree3)
+- [CMake - Advanced](extra/cmake_advanced)
 - [Contributions](extra/contributions)
+- [News](extra/news)
 
 ## Contributions
 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -48,6 +48,7 @@ nav:
   - Extra:
     - Tools: extra/tools.md
     - Data: extra/data.md
-    - News: extra/news.md
     - Embree 3: extra/embree3.md
-    - Contributions: extra/contributions.md
+    - CMake - Advanced: extra/cmake_advanced.md
+    - Contributions: extra/contributions.md
+    - News: extra/news.md

Original file line number	Diff line number	Diff line change
`@@ -105,4 +105,7 @@ target_link_libraries(my_rmagine_app`
`105`	`105`	`rmagine::cuda`
`106`	`106`	`rmagine::optix`
`107`	`107`	`)`
`108`		-```
	`108`	+```
	`109`	`+`
	`110`	`+`
	`111`	`+For more details and alternate ways of integrating Rmagine into your CMake project we refer to: [CMake - Advanced](/extra/cmake_advanced.md).`