Better README, write first draft of documentation
[westcastle.git] / README.md
index b9df387..edeb595 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@ 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[,pdt,session,présent]
+ 2. éditer joueurs.csv en s'inspirant de joueurs.sample.csv. Format en lignes : prénom,nom[,pdt,session,présent]
 
 pdt, session, présent : optionnels (par défaut resp. 0, 0, 1).
 
@@ -20,8 +20,13 @@ pdt = "points de table" ; session = "mini-points"
 
  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 (mini-)points. Pour lancer la ronde suivante, revenir en 1.
+ 3. Lancer le chrono (section "chronomètre", puis click gauche, puis passer en plein écran [F11])
+ 4. À la fin d'une ronde, cliquer sur chaque table pour indiquer les (mini-)points.
 
-Le classement est mis à jour dans la rubrique correspondante et dans joueurs.csv. Il peut être réinitialisé (bouton en haut).
+Le classement est mis à jour dans la rubrique correspondante et dans joueurs.csv. Il peut être réinitialisé (bouton en haut).
 
 Après chaque opération sur les points, en cas d'erreur le bouton "Restaurer" en haut à droite annule la dernière opération.
+
+-----
+
+Pour plus de détails, naviguer vers localhost:8000/doc