tykayn/teambrain
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

up makefile

Browse Source
This commit is contained in:
Tykayn 2023-10-04 16:25:17 +02:00 committed by tykayn
parent 776e4f9fa5
commit 62a34e426f
2 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Makefile
View File

@ -9,11 +9,12 @@ default:
git submodule add git@github.com:cogiway/faq2_model.git git submodule add git@github.com:cogiway/faq2_model.git
git submodule init git submodule init
echo "checking requirements" echo "checking requirements"
doc: documentation:
echo "build mkdoc" echo "build mkdoc"
mkdocs build doc mkdocs build
test: test:
echo "run php tests" echo "run php tests"
phpunit -c tests phpunit
docker: docker:
docker-compose up -d docker-compose up -d
echo "open http://0.0.0.0:8181"

12
README.md
View File

@ -1,4 +1,4 @@
# TeamBrain # TeamBrain
Frequently asked questions 2 - FAQ2 Frequently asked questions 2 - FAQ2
Module permettant d'intégrer une FAQ sur son site web. Module permettant d'intégrer une FAQ sur son site web.
@ -12,25 +12,25 @@ Module permettant d'intégrer une FAQ sur son site web.
* [traduction](docs/translate.md) * [traduction](docs/translate.md)
# Installation # Installation
Cloner le dépôt: Cloner le dépôt:
```bash ```bash
git clone --recurse-submodules https://forge.chapril.org/tykayn/teambrain 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 : Pour installer les sous modules et les dépendances de dev permettant de construire la documentation, lancer la commande :
```bash ```bash
make make
``` ```
# Contributions # Contributions
Voir les [directives de contribution](docs/contribute.md) Voir les [directives de contribution](docs/contribute.md)
# Composants # Composants
Ce module s'articule en trois parties: Ce module s'articule en trois parties:
* api * api
* example * example
* model * model
Le détail est à parcourir dans [la documentation d'architecture](docs/architecture.md) Le détail est à parcourir dans [la documentation d'architecture](docs/architecture.md)