improve documentation

[westcastle.git] / README.md

diff --git a/README.md b/README.md
index fe69cc4..4654ca7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,23 +1,21 @@
 ## Prérequis
 
-php (assez récent)
+php >= 5.4
 
 ## 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]
+ 2. éditer joueurs.csv en s'inspirant de joueurs.sample.csv. Format en lignes : prénom,nom[,pdt,session,présent]
 
-pdt = "points de table". score,pdt,présent : optionnels (défaut 0, 0, 1)
+pdt, session, présent : optionnels (par défaut resp. 0, 0, 1).
+
+pdt = "points de table" ; session = "mini-points"
 
 ## 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
+ - [Windows,MacOS] `php -S localhost:8000` puis aller à http://localhost:8000 dans un navigateur web
 
 ## 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
+Naviguer vers http://localhost:8000/doc