teambrain/README.md

40 lines
922 B
Markdown
Raw Permalink Normal View History

2023-10-04 16:25:17 +02:00
# TeamBrain
2023-08-28 12:54:38 +02:00
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)
2023-08-28 12:59:13 +02:00
2023-10-04 16:25:17 +02:00
# Installation
2023-08-28 13:17:59 +02:00
Cloner le dépôt:
```bash
git clone --recurse-submodules https://forge.chapril.org/tykayn/teambrain
2023-10-04 16:25:17 +02:00
```
2023-10-04 16:47:53 +02:00
## Prérequis
* python version 3+
* python-pip version 22+
2023-08-28 13:17:59 +02:00
2023-08-28 12:54:38 +02:00
Pour installer les sous modules et les dépendances de dev permettant de construire la documentation, lancer la commande :
2023-08-28 12:59:13 +02:00
2023-08-28 12:54:38 +02:00
```bash
2023-10-04 16:25:17 +02:00
make
2023-08-28 12:54:38 +02:00
```
2023-08-28 12:59:13 +02:00
2023-08-28 12:54:38 +02:00
# Contributions
Voir les [directives de contribution](docs/contribute.md)
2023-10-04 16:25:17 +02:00
# Composants
2023-08-28 12:54:38 +02:00
Ce module s'articule en trois parties:
* api
* example
* model
2023-10-04 16:25:17 +02:00
Le détail est à parcourir dans [la documentation d'architecture](docs/architecture.md)