deblan/le-pere-noel-secret
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

add documentation

Browse source
This commit is contained in:
Simon Vieille 2020-10-31 22:00:29 +01:00
parent 554889a657
commit 4d6a5bd05a
Signed by: deblan
GPG key ID: 03383D15A1D31745
1 changed files with 25 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md Normal file
View 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`.