Better README, write first draft of documentation
[westcastle.git] / README.md
1 ## Prérequis
2
3 php >= 5.4
4
5 ## Ajustement du fichier de données
6
7 1. Renommer joueurs.csv.dist en joueurs.csv
8 2. éditer joueurs.csv en s'inspirant de joueurs.sample.csv. Format en lignes : prénom,nom[,pdt,session,présent]
9
10 pdt, session, présent : optionnels (par défaut resp. 0, 0, 1).
11
12 pdt = "points de table" ; session = "mini-points"
13
14 ## Lancement de l'aplication
15
16 - [Linux] Double click sur "westcastle.sh", ou lancement depuis un terminal
17 - [Windows,MacOS] `php -S localhost:8000` puis naviguer vers index.html
18
19 ## Utilisation
20
21 1. Cliquer sur les joueurs absents dans l'onglet "joueurs"
22 2. Aller dans la section "appariements" et cliquer sur le bouton en haut
23 3. Lancer le chrono (section "chronomètre", puis click gauche, puis passer en plein écran [F11])
24 4. À la fin d'une ronde, cliquer sur chaque table pour indiquer les (mini-)points.
25
26 Le classement est mis à jour dans la rubrique correspondante et dans joueurs.csv. Il peut être réinitialisé (bouton en haut).
27
28 Après chaque opération sur les points, en cas d'erreur le bouton "Restaurer" en haut à droite annule la dernière opération.
29
30 -----
31
32 Pour plus de détails, naviguer vers localhost:8000/doc