Ajout d'instructions

Ajout d'instructions sur l'installation et la désinstallation, ainsi qu'un lien
vers le wiki pour y trouver des renseignements utiles
This commit is contained in:
Valentin Moguérou 2021-10-31 11:25:12 +01:00
parent ea7a690234
commit 33b5a19aae

View File

@ -1,3 +1,43 @@
# catwalk-cli
# Catwalk CLI
Interface en lignes de commande pour le jeu Catwalk
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
```