diff --git a/Makefile b/Makefile index 65c4c7c..3b4600a 100755 --- a/Makefile +++ b/Makefile @@ -9,11 +9,12 @@ default: git submodule add git@github.com:cogiway/faq2_model.git git submodule init echo "checking requirements" -doc: +documentation: echo "build mkdoc" - mkdocs build doc + mkdocs build test: echo "run php tests" - phpunit -c tests + phpunit docker: docker-compose up -d + echo "open http://0.0.0.0:8181" diff --git a/README.md b/README.md index 11d43f5..6ef3afe 100755 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# TeamBrain +# TeamBrain Frequently asked questions 2 - FAQ2 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) -# Installation +# 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 +make ``` # Contributions Voir les [directives de contribution](docs/contribute.md) -# Composants +# Composants Ce module s'articule en trois parties: * api * example * model -Le détail est à parcourir dans [la documentation d'architecture](docs/architecture.md) \ No newline at end of file +Le détail est à parcourir dans [la documentation d'architecture](docs/architecture.md)