From 56f0648d88c11e9cad28b9eb694ba388e4bc93db Mon Sep 17 00:00:00 2001
From: saxodwarf <saxodwarf@noreply.localhost>
Date: Sun, 14 Apr 2024 22:38:53 +0200
Subject: [PATCH] Add more information to readme.md

---
 README.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 60 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index eddbf3d..de66104 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,61 @@
-# Devinddessin
+# Devine-dessin
 
+Jeu permettant de dessiner un mot choisi au hasard dans une liste.
+
+Tant que le jeu n'est pas quitté, les mots de la liste ne sont pas proposé à nouveau.
+
+## Liste de mot
+
+La liste de mot peut être au format texte brut, avec un mot par ligne, ou au format CSV.
+
+Si la liste est au format CSV, la première colonne doit contenir le mot à dessiner, et la seconde colonne peut contenir un indice.
+Les colonnes du fichier CSV ne doivent pas avoir de titre.
+
+Par défaut, le jeu cherche une liste dans un fichier du dossier courant nommé `mots.csv`.
+
+## Installation
+
+Le jeu n'est pour l'instant pas packagé.
+Pour le lancer:
+
+- Construire une liste de mot comme présenté plus haut
+- Créer un venv : `python -m venv <path_to_venv>`
+- Activer le venv : `. <path_to_venv>/bin/activate`
+- Installer les dépendances : `pip install -r requirements.txt`
+- Récupérer le fichier `guess_what_I_draw.py`
+- Lancer le jeu en exécutant le fichier.
+
+
+## Contrôles:
+
+### Tout le temps:
+- **`Échap` :** Quitter le jeu immédiatement
+
+### Quand le jeu n'est pas lancé:
+- **`c`:** Ouvrir le menu de configuration
+- **`Espace` :** Lancer la manche
+
+### Quand le jeu est en cours:
+- **Clic gauche** dans la zone de dessin : dessiner
+- **`Ctrl + z` :** Annuler le dernier trait
+- **`Entrer` :** Passer le mot en cours (une pénalité de temps est appliquée)
+- **`Espace` :** Valider le mot en cours comme "trouvé"
+- **`p` :** Activer/Désactiver la pause.
+
+### Quand la manche est écoulée:
+Le menu de récapitulation est affiché.
+- **`Backspace` :** Passer au tour suivant
+
+## Configuration
+Dans le menu de configuration, il est possible de configurer :
+- Le chemin vers la liste de mot ;
+- La durée d'une manche ;
+- Le temps de pénalité appliqué pour chaque mot passé.
+
+Une fois la configuration effectuée, vous pouvez l'appliquer en cliquant en dehors de la pop-up du menu
+
+
+## Dessins
+Les dessins sont sauvegardés pour la postérité dans un dossier créé dans le répertoire courant, nommé `<date au format iso>T<heure-minutes>_creations`.
+
+Le nom des fichiers de dessin sont au format `round-<i>_<mot à deviner>.png`, avec `i` le numéro de la manche.