'Toto' player handling, fix ranking, cosmetics

[westcastle.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..fe69cc4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+## Prérequis
+
+php (assez récent)
+
+## Ajustement du fichier de données
+
+ 1. Renommer joueurs.csv.dist en joueurs.csv
+ 2. éditer joueurs.csv (ajout de joueurs, édition, suppression...). Format en lignes : prénom,nom[,score,pdt,présent]
+
+pdt = "points de table". score,pdt,présent : optionnels (défaut 0, 0, 1)
+
+## Lancement de l'aplication
+
+ - [Linux] Double click sur "westcastle.sh", ou lancement depuis un terminal
+ - [Windows,MacOS] `php -S localhost:8000` puis naviguer vers index.html
+
+## Utilisation
+
+ 1. Cliquer sur les joueurs absents dans l'onglet "joueurs"
+ 2. Aller dans la section "appariements" et cliquer sur le bouton en haut
+ 3. À la fin d'une ronde, cliquer sur chaque table pour indiquer les points. Pour lancer la ronde suivante, revenir en 1)
+
+Le classement est mis à jour dans la rubrique correspondante et dans joueurs.csv