From bbc6ac32c3f249c9a161cce78714050d043008f0 Mon Sep 17 00:00:00 2001
From: Johann Dreo <johann.dreo@pasteur.fr>
Date: Tue, 10 Sep 2024 11:35:22 +0200
Subject: [PATCH] doc(README): usage as a Git submodule

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.md b/README.md
index 3bf523f..d94ada6 100644
--- a/README.md
+++ b/README.md
@@ -791,3 +791,21 @@ ctest
 
 There's a script that tests all the build types combinations: `./build_all.sh`.
 
+
+Usage as a Git submodule
+========================
+
+If you are using Git and CMake, it is easy to include Clutchlog as a dependency.
+
+First, add Clutchlog as a submodule of your repository:
+```sh
+git submodule add git@github.com:nojhan/clutchlog.git external/
+git commit -m "Add clutchlog as a submodule dependency"
+```
+
+Then, in your `CMakeLists.txt` file, add:
+```cmake
+include_directories(external/clutchlog)
+```
+
+And that's it.