add documentation
This commit is contained in:
parent
554889a657
commit
4d6a5bd05a
25
README.md
Normal file
25
README.md
Normal file
|
@ -0,0 +1,25 @@
|
||||||
|
Le père noël secret
|
||||||
|
===================
|
||||||
|
|
||||||
|
Tirage au sort d'une personne à qui offrir un cadeau.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
```
|
||||||
|
$ git clone https://gitnet.fr/deblan/le-pere-noel-secret.git
|
||||||
|
$ cd le-pere-noel-secret
|
||||||
|
$ cp etc/config.php.dist etc/config.php
|
||||||
|
```
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
La racine du site est `public/`.
|
||||||
|
|
||||||
|
Éditer `etc/config.php` :
|
||||||
|
|
||||||
|
* La liste des personnes qui composent le père noël secret.
|
||||||
|
L'index définit la "clé secrète" pour générer le lien à partager
|
||||||
|
Pour "Name 1", son lien sera "https://exemple.fr/index.php?p=foo" tandis pour "Name 2" le lien sera "https://exemple.fr/index.php?p=bar".
|
||||||
|
* La liste des restrictions pour définir ceux qui ne s'offiront jamais de cadeau
|
||||||
|
|
||||||
|
Les résultats sont stockés dans `datas/results.json`.
|
Loading…
Reference in a new issue