Fix typo in file name, add initialisation step from CSV in documentation

[westcastle.git] / doc / index.pug

diff --git a/doc/index.pug b/doc/index.pug
index 99aaef2..80ba8d1 100644 (file)
--- a/doc/index.pug
+++ b/doc/index.pug
@@ -4,17 +4,17 @@ html
        head
                meta(charset="utf-8")
                title Westcastle usage
        head
                meta(charset="utf-8")
                title Westcastle usage

-               link(rel="stylesheet", href="doc/index.css")
+               link(rel="stylesheet", href="index.css")

 
        body
 
                span.tldr TL;DR:
                ol
 
        body
 
                span.tldr TL;DR:
                ol

-                       li Cliquer sur les joueurs absents dans l'onglet "joueurs"
-                       li Aller dans la section "appariements" et cliquer sur le bouton en haut
-                       li Lancer le chrono (section "chronomètre", puis click gauche [puis F11])
-                       li À la fin d'une ronde, cliquer sur chaque table pour indiquer les (mini-)points.
-               p Le classement est mis à jour dans la rubrique correspondante et dans joueurs.csv.
+                       li Cliquer sur les joueurs absents dans l'onglet "Participants"
+                       li Aller dans la section "appariements" et cliquer sur le bouton "Nouvelle ronde"
+                       li Lancer le chrono (section "Chronomètre", puis click gauche [puis F11])
+                       li Après la ronde, cliquer sur chaque table pour indiquer les (mini-)points, #[br] #[strong puis cliquer sur "Valider".]
+               p Le classement est mis à jour dans la rubrique correspondante.

 
                p Voir aussi la #[a(href="https://auder.net/westcastle_demo.webm") vidéo de démonstration]
 
 
                p Voir aussi la #[a(href="https://auder.net/westcastle_demo.webm") vidéo de démonstration]
 


@@ -25,10 +25,15 @@ html
                        li Participants : la liste des joueurs présents (et absents)
                        li Appariements : répartition des joueurs présents par tables
                        li Chronomètre : un chrono qui démarre à 1h30 et sonne une fois à zéro
                        li Participants : la liste des joueurs présents (et absents)
                        li Appariements : répartition des joueurs présents par tables
                        li Chronomètre : un chrono qui démarre à 1h30 et sonne une fois à zéro

-                       li Classement : le tableau des scores (voir aussi joueurs.csv)
+                       li Classement : le tableau des scores

 
                h2 Participants
 
 
                h2 Participants
 

+               p.
+                       Au premier lancement de l'application, la liste des joueurs est vide : il faut cliquer sur "(Ré)initialiser",
+                       puis choisir le fichier participants.csv contenant les prénoms + noms des joueurs en lignes, comme dans participants.csv.sample.
+                       Le contenu de la première ligne d'en-tête est arbitraire, mais celle-ci doit être présente.
+

                p.
                        Un clic sur un joueur présent l'enlève des joueurs actifs (il est absent) ;
                        réciproquement, un clic sur un absent le ramène dans la liste des joueurs actifs.
                p.
                        Un clic sur un joueur présent l'enlève des joueurs actifs (il est absent) ;
                        réciproquement, un clic sur un absent le ramène dans la liste des joueurs actifs.


@@ -47,9 +52,7 @@ html
                        et la table s'affiche désormais sur fond vert. Un clic sur "Fermer" annule l'opération, aucun changement n'est effectué.
 
                p.
                        et la table s'affiche désormais sur fond vert. Un clic sur "Fermer" annule l'opération, aucun changement n'est effectué.
 
                p.

-                       En cas d'erreur, #[strong ne surtout pas scorer une nouvelle table :] d'abord restaurer l'état précédent en cliquant sur le bouton "Restaurer"
-                       sur l'écran de classement ; alternativement, on peut cliquer sur le lien présent dans l'avertissement lorsqu'on reclique sur la table en question.
-                       Ensuite, rentrer les scores corrigés.
+                       En cas d'erreur, re-cliquer sur la table à corriger : cliquer ensuite sur "Annuler", puis ré-entrer les scores.

 
                h2 Chronomètre
 
 
                h2 Chronomètre
 


@@ -69,7 +72,9 @@ html
 
                p.
                        Les scores sont ordonnés par points de table décroissants d'abord, puis en cas d'ex-aequos par mini-points décroissants.
 
                p.
                        Les scores sont ordonnés par points de table décroissants d'abord, puis en cas d'ex-aequos par mini-points décroissants.

+                       Ils peuvent être téléchargés via le bouton en haut à droite. Dans le fichier, "pdt" indique les points de table cumulés
+                       et "session" les points de session cumulés (aussi appelés mini-points).

 
 

-               p.
-                       Un clic sur "Réinitialiser" remet tous les compteurs à zéro : par exemple pour démarrer un nouveau cycle de tournois.
-                       Cette action peut être annulée (immédiatement après) en cliquant sur "Restaurer".
+               p
+                       | Un clic sur "Réinitialiser" remet tous les compteurs à zéro : par exemple pour démarrer un nouveau cycle de tournois. 
+                       strong Attention cette action est irréversible.