diff --git a/README.md b/README.md index 197b8e6..b34c8df 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,43 @@ -# catwalk-cli +# Catwalk CLI -Interface en lignes de commande pour le jeu Catwalk \ No newline at end of file +Interface en lignes de commande pour le jeu Catwalk + +## Instructions d'installation + +**Attention: La compilation et l'éxécution de Catwalk CLI requièrent l'installation de la bibliothèque [libcatwalk](https://git.kaz.bzh/valentin/libcatwalk).** + +1. Il faut d'abord cloner le dépôt : +``` +$ git clone https://git.kaz.bzh/valentin/catwalk-cli.git +``` +2. Il faut accéder au dépôt +``` +$ cd catwalk-cli +``` +3. Ensuite, il faut compiler : +``` +$ make +``` +4. Enfin, il faut installer : +``` +$ sudo make install +``` +ou +``` +# make install +``` + +## Utilisation + +Une aide précise est disponible sur le [wiki](https://git.kaz.bzh/valentin/catwalk-cli/wiki/). + +## Désinstallation + +Pour désinstaller, il faut éxécuter +``` +$ sudo make uninstall +``` +ou +``` +# make uninstall +```