From 04b311fa4b17991d7dbb8594ec180323cfc9c861 Mon Sep 17 00:00:00 2001
From: Jan Kuhlmann <33833587+M2-TE@users.noreply.github.com>
Date: Tue, 3 Dec 2024 14:04:15 +0100
Subject: [PATCH] Create README.md

---
 README.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 68 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3551ab0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,68 @@
+# CHAD TSDF
+
+CHAD TSDF structure for SLAM
+
+## Description
+
+TODO: link to ros implementation
+
+## Getting Started
+
+<details>
+    <summary>CMake options</summary>
+
+TODO:
+set(CHAD_POPCOUNT_INSTRUCTION std::popcount<uint8_t>)
+set(CHAD_NORM_NEIGH_UPPER 20)
+set(CHAD_NORM_NEIGH_LOWER 2)
+set(CHAD_NORM_MIN_NEIGH 3)
+set(CHAD_NORM_RADIUS_MOD 1.5)
+set(CHAD_LEAF_RESOLUTION 0.1)
+set(CHAD_LEAF_BITS 8)
+</details>
+
+<details>
+    <summary>CMake Build</summary>
+    
+#### 1. CMake local build
+
+```
+cmake -B build
+cmake --build build
+TODO: install
+TODO: CMake find()
+```
+
+#### 2. CMake subdirectory
+
+```cmake
+add_subdirectory(${CHAD_DIRECTORY})
+target_link_libraries(${PROJECT_NAME} PUBLIC chad::tsdf)
+```
+
+#### 3. CMake FetchContent
+
+```cmake
+include(FetchContent)
+FetchContent_Declare(chad_tsdf
+    GIT_REPOSITORY "https://github.com/M2-TE/chad_tsdf.git"
+    GIT_TAG "main"
+    GIT_SHALLOW ON)
+FetchContent_MakeAvailable(chad_tsdf)
+target_link_libraries(${PROJECT_NAME} PUBLIC chad::tsdf)
+```
+</details>
+
+
+## Authors
+
+Jan Kuhlmann
+
+## Version History
+
+* 0.1
+    * Initial Release
+
+## Acknowledgments
+
+* [parallel-hashmap](https://github.com/greg7mdp/parallel-hashmap)