From 67408629b8043aa25e95255dc8302f8477e15cd3 Mon Sep 17 00:00:00 2001
From: Pascal Palenda <pascal.palenda@akustik.rwth-aachen.de>
Date: Wed, 15 Feb 2023 09:38:35 +0100
Subject: [PATCH] Add features to README

---
 README.md | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 8c92600..f0d405b 100644
--- a/README.md
+++ b/README.md
@@ -4,4 +4,13 @@ A collection of CMake helper functions and tools that are common to all IHTA C++
 
 ## Features
 
-t.b.d.
+- `ihta_add_library`: Adds a library target with all common settings.
+  This also allows to add a unit test executable with the same command.
+  Furthermore, if unit tests are desired, one can also use the option `TEST_INTERNALS` to be able to test the internal parts of the library.
+- Checks if [`CPM.cmake`](https://github.com/cpm-cmake/CPM.cmake) is available and downloads it if not.
+  For this, it expects the `CPM.cmake` file to be in `${CMAKE_BINARY_DIR}/cmake`.
+- Download some common CMake libraries in [`GroupSourcesByFolder.cmake`](https://github.com/TheLartians/GroupSourcesByFolder.cmake) and [`PackageProject.cmake`](https://github.com/TheLartians/PackageProject.cmake) and patches them for our build system.
+- `init_project`: Initializes some common settings for a project.
+  Primarily sets the output `bin` and `lib` directories so debugging works on windows builds.
+- `ihta_add_test`: Adds a unit test executable target including downloading the dependencies, CTest registration and optional code coverage.
+- `build_doc`: Builds doxygen documentation with nice styling.
-- 
GitLab