teambrain/README.md

# TeamBrain
Frequently asked questions 2 - FAQ2

Module permettant d'intégrer une FAQ sur son site web.
# Documentation
[index de la documentation](docs/index.md)
* [configuration](docs/configuration.md)
* [contribuer](docs/contribute.md)
* [roadmap](docs/roadmap.md)
* [styles](docs/style.md)
* [tests](docs/testing.md)
* [traduction](docs/translate.md)


# 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
make 
```

# Contributions
Voir les [directives de contribution](docs/contribute.md)

# Composants
Ce module s'articule en trois parties:
* api
* example
* model

Le détail est à parcourir dans [la documentation d'architecture](docs/architecture.md)