up doc install

.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/

.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

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

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