From 33b5a19aae3bd5c029978b594e3bbe0162251400 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Valentin=20Mogu=C3=A9rou?= Date: Sun, 31 Oct 2021 11:25:12 +0100 Subject: [PATCH] Ajout d'instructions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Ajout d'instructions sur l'installation et la désinstallation, ainsi qu'un lien vers le wiki pour y trouver des renseignements utiles --- README.md | 44 ++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 42 insertions(+), 2 deletions(-) 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 +```