From b5a55d23e249e3d13d593a3db9e74e4891828506 Mon Sep 17 00:00:00 2001
From: Tykayn <contact@cipherbliss.com>
Date: Mon, 28 Aug 2023 13:17:59 +0200
Subject: [PATCH] up doc install

---
 .gitignore      | 6 ++++++
 .gitmodules     | 9 +++++++++
 README.md       | 5 +++++
 docs/roadmap.md | 3 +++
 4 files changed, 23 insertions(+)
 create mode 100644 .gitmodules

diff --git a/.gitignore b/.gitignore
index 7a9ec57..5a47792 100644
--- a/.gitignore
+++ b/.gitignore
@@ -78,4 +78,10 @@ fabric.properties
 .idea/caches/build_file_checksums.ser
 
 vendor/*
+# site de documentation
 /site/
+
+# sous modules
+/faq2_api/
+/faq2_example/
+/faq2_model/
diff --git a/.gitmodules b/.gitmodules
new file mode 100644
index 0000000..0b27e35
--- /dev/null
+++ b/.gitmodules
@@ -0,0 +1,9 @@
+[submodule "faq2_api"]
+	path = faq2_api
+	url = git@github.com:cogiway/faq2_api.git
+[submodule "faq2_example"]
+	path = faq2_example
+	url = git@github.com:cogiway/faq2_example.git
+[submodule "faq2_model"]
+	path = faq2_model
+	url = git@github.com:cogiway/faq2_model.git
diff --git a/README.md b/README.md
index 4857f1f..11d43f5 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,11 @@ Module permettant d'intégrer une FAQ sur son site web.
 
 
 # Installation
+Cloner le dépôt:
+```bash
+ git clone --recurse-submodules https://forge.chapril.org/tykayn/teambrain
+``` 
+
 Pour installer les sous modules et les dépendances de dev permettant de construire la documentation, lancer la commande :
 
 ```bash
diff --git a/docs/roadmap.md b/docs/roadmap.md
index 2bd10d2..3c39893 100644
--- a/docs/roadmap.md
+++ b/docs/roadmap.md
@@ -4,3 +4,6 @@ Plan des prochaines réalisations:
 * redirection vers une page 404 quand la FAQ demande une page inexistante
   * configuration serveur
   * routeur interne au coeur applicatif
+* avoir une debug toolbar
+* avoir un outil de gestion des logs d'erreur
+* documentation générale