Put documentation link in README, add some badges
This commit is contained in:
Yohann D'ANELLO
parent
eddf04fc36
commit
1d8ecf49f9
117
README.md
117
README.md
|
|
@ -1,118 +1,15 @@
|
|||
[](https://gitlab.crans.org/ynerant/squirrel-battle/-/commits/master)
|
||||
[](https://gitlab.crans.org/ynerant/squirrel-battle/-/commits/master)
|
||||
[](https://squirrel-battle.readthedocs.io/fr/latest/?badge=latest)
|
||||
[](https://pypi.org/project/squirrel-battle/)
|
||||
[](https://pypi.org/project/squirrel-battle/)
|
||||
[](https://aur.archlinux.org/packages/python-squirrel-battle/)
|
||||
[](https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
# Squirrel Battle
|
||||
|
||||
Attention aux couteaux des écureuils !
|
||||
|
||||
## Création d'un environnement de développement
|
||||
## Documentation
|
||||
|
||||
Il est toujours préférable de travailler dans un environnement Python isolé du reste de son instalation.
|
||||
|
||||
1. **Installation des dépendances de la distribution.**
|
||||
Vous devez déjà installer Python et le module qui permet de créer des environnements virtuels.
|
||||
On donne ci-dessous l'exemple pour une distribution basée sur Debian, mais vous pouvez facilement adapter pour ArchLinux ou autre.
|
||||
|
||||
```bash
|
||||
$ sudo apt update
|
||||
$ sudo apt install --no-install-recommends -y python3-setuptools python3-venv python3-dev git
|
||||
```
|
||||
|
||||
2. **Clonage du dépot** là où vous voulez :
|
||||
|
||||
```bash
|
||||
$ git clone git@gitlab.crans.org:ynerant/squirrel-battle.git && cd squirrel-battle
|
||||
```
|
||||
|
||||
3. **Création d'un environment de travail Python décorrélé du système.**
|
||||
On n'utilise pas `--system-site-packages` ici pour ne pas avoir des clashs de versions de modules avec le système.
|
||||
|
||||
```bash
|
||||
$ python3 -m venv env
|
||||
$ source env/bin/activate # entrer dans l'environnement
|
||||
(env)$ pip3 install -r requirements.txt
|
||||
(env)$ deactivate # sortir de l'environnement
|
||||
```
|
||||
|
||||
### Exécution des tests
|
||||
|
||||
Les tests sont gérés par `pytest` dans le module `squirrelbattle.tests`.
|
||||
|
||||
`tox` est un outil permettant de configurer l'exécution des tests. Ainsi, après
|
||||
installation de tox dans votre environnement virtuel via `pip install tox`,
|
||||
il vous suffit d'exécuter `tox -e py3` pour lancer les tests et `tox -e linters`
|
||||
pour vérifier la syntaxe du code.
|
||||
|
||||
|
||||
## Lancement du jeu
|
||||
|
||||
Après clonage du projet, il suffit d'exécuter `python3 main.py`.
|
||||
|
||||
Sinon, le jeu est déployé dans PyPI, et il suffit d'exécuter :
|
||||
|
||||
```
|
||||
pip install squirrel-battle
|
||||
```
|
||||
|
||||
pour télécharger et installer le jeu. Lancer `squirrel-battle` suffit ensuite
|
||||
à lancer le jeu depuis n'importe où. Pour mettre à jour :
|
||||
|
||||
```
|
||||
pip install --upgrade squirrel-battle
|
||||
```
|
||||
|
||||
Sous Arch Linux, le paquet `python-squirrel-battle-git` dans l'AUR permet
|
||||
également d'installer directement le jeu.
|
||||
|
||||
## Gestion des émojis
|
||||
|
||||
Le jeu dispose de deux modes graphiques : en mode `ascii` et `squirrel`.
|
||||
Le mode `squirrel` affiche des émojis pour un meilleur affichage. Toutefois,
|
||||
il est possible que vous n'ayez pas les bonnes polices.
|
||||
|
||||
### Sous Windows
|
||||
|
||||
Sous Windows, vous devriez avoir les bonnes polices installées nativement.
|
||||
|
||||
### Sous Arch Linux
|
||||
|
||||
Il est recommandé d'utiliser le terminal `xfce4-terminal`. Il suffit d'installer
|
||||
le paquets de polices
|
||||
|
||||
```bash
|
||||
sudo pacman -Sy noto-fonts-emoji
|
||||
```
|
||||
|
||||
Le jeu doit ensuite se lancer normalement sans action supplémentaire.
|
||||
|
||||
### Sous Ubuntu/Debian
|
||||
|
||||
À nouveau, le terminal `xfce4-terminal` est recommandé. Le paquet
|
||||
`fonts-noto-color-emoji`. Toutefois, le rythme de mise à jour de Debian étant
|
||||
lent, le paquet le plus récent ne contient pas tous les émojis. Sur Debian,
|
||||
il faudra donc installer le paquet le plus récent, ce qui fonctionne sans
|
||||
dépendance supplémentaire :
|
||||
|
||||
```bash
|
||||
wget http://ftp.fr.debian.org/debian/pool/main/f/fonts-noto-color-emoji/fonts-noto-color-emoji_0~20200916-1_all.deb
|
||||
dpkg -i fonts-noto-color-emoji_0~20200916-1_all.deb
|
||||
rm fonts-noto-color-emoji_0~20200916-1_all.deb
|
||||
```
|
||||
|
||||
Il reste le problème de l'écureuil. Sous Ubuntu et Debian, le caractère écureuil
|
||||
existe déjà, mais ne s'affiche pas proprement. On peut appliquer un patch qui
|
||||
permet d'afficher les émojis correctement dans son terminal. Pour cela, il
|
||||
suffit de faire :
|
||||
|
||||
```bash
|
||||
ln -s $PWD/fix-squirrel-emojis.conf /etc/fonts/conf.avail/75-fix-squirrel-emojis.conf
|
||||
ln -s /etc/fonts/conf.avail/75-fix-squirrel-emojis.conf /etc/fonts/conf.d/75-fix-squirrel-emojis.conf
|
||||
```
|
||||
|
||||
Après redémarrage du terminal, l'écureuil devrait s'afficher correctement.
|
||||
|
||||
Pour supprimer le patch :
|
||||
|
||||
```bash
|
||||
rm /etc/fonts/conf.d/75-fix-squirrel-emojis.conf
|
||||
```
|
||||
La documentation du projet est présente sur [squirrel-battle.readthedocs.io](https://squirrel-battle.readthedocs.io).
|
||||
|
|
|
|||
|
|
@ -1,6 +1,35 @@
|
|||
Bienvenue dans la documentation de Squirrel Battle !
|
||||
====================================================
|
||||
|
||||
.. image:: https://gitlab.crans.org/ynerant/squirrel-battle/badges/master/pipeline.svg
|
||||
:target: https://gitlab.crans.org/ynerant/squirrel-battle/-/commits/master
|
||||
:alt: Pipeline status
|
||||
|
||||
.. image:: https://gitlab.crans.org/ynerant/squirrel-battle/badges/master/coverage.svg
|
||||
:target: https://gitlab.crans.org/ynerant/squirrel-battle/-/commits/master
|
||||
:alt: Coverage report
|
||||
|
||||
.. image:: https://readthedocs.org/projects/squirrel-battle/badge/?version=latest
|
||||
:target: https://squirrel-battle.readthedocs.io/fr/latest/?badge=latest
|
||||
:alt: Documentation Status
|
||||
|
||||
.. image:: https://img.shields.io/pypi/v/dungeon-battle
|
||||
:target: https://pypi.org/project/squirrel-battle/
|
||||
:alt: PyPI
|
||||
|
||||
.. image:: https://img.shields.io/pypi/dm/dungeon-battle
|
||||
:target: https://pypi.org/project/squirrel-battle/
|
||||
:alt: PyPI downloads
|
||||
|
||||
.. image:: https://img.shields.io/aur/version/python-squirrel-battle
|
||||
:target: https://aur.archlinux.org/packages/python-squirrel-battle/
|
||||
:alt: AUR version
|
||||
|
||||
.. image:: https://img.shields.io/badge/License-GPL%20v3-blue.svg
|
||||
:target: https://www.gnu.org/licenses/gpl-3.0.txt
|
||||
:alt: License: GPL v3
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:caption: Développer
|
||||
|
|
|
|||
Loading…
Reference in New Issue