nono · nono
--- a/README.md

+ 30

− 95
+++ b/README.md

+ 30

− 95
 # Site de Don de La Quadrature Du Net

-Ce site web, écrit en PHP avec le framework Fat-Free-Framework permet de gérer les donnations et les contreparties pour La Quadrature Du Net. ( English below )
+Ce site web, écrit en PHP avec le framework Fat-Free-Framework pour nous permettre de gérer les donnations et les contreparties pour La Quadrature Du Net. ( English below )

 ## Conception

+Ce site à été conçu de zéro, par des bénévoles, des salariés et des membres de La Quadrature Du Net.
+
 ## Installation

 Vous aurez besoin de ;
 @@ -14,15 +16,31 @@ Vous aurez besoin de ;

 ### En production

-#### Serveur web
+Afin de faciliter le déployement, vous pouvez utiliser une recette Ansible pour le déployement en production. [Vous pouvez la consulter ici](https://git.laquadrature.net/lqdn-interne/piops-roles/don-lqdn).
+
+Autrement, vous aurez besoin de :
+
+##### Téléchargement
+
+- Release
+
+##### Configuration du serveur
+
+- Installation des dépendances

-#### Connection à la banque
+##### Configuration des paramètres du site web

-#### Gestion
+- Configuration du .env
+
+##### Serveur web
+
+##### Connexion à la banque
+
+##### Gestion

 ### En test

-Afin de faciliter les test, nous avons inclus un fichier Vagrant, qui permet de lancer une machine virtuelle pré-configurée avec toutes les dépendances nécessaire pour tester le site de don, à l'exception du mode de banque pour le moment, mais rien n'empêche que vous le mettiez en place.
+Afin de faciliter les test, nous avons inclus un fichier Vagrant, qui permet de lancer une machine virtuelle pré-configurée avec toutes les dépendances nécessaire pour tester le site de don, à l'exception du mode de banque pour le moment ( mais rien n'empêche que vous le mettiez en place. )

 Afin de lancer la machine de développement, vous pouvez ;

 @@ -31,8 +49,14 @@ Afin de lancer la machine de développement, vous pouvez ;
 - Vous avez maintenant une machine virtuelle accessible via ssh avec `vagrant ssh`, et vous pouvez voir le site de don sur `localhost:8383`.
 - Vous pouvez faire vos modifications directement dans le dossier du dépôt, car il est lié sur la machine virtuelle, sous le chemin `/vagrant`.

+Le déployement se fait dans la machine virtuelle de test se fait au moyen de la recette ansible [don-lqdn](https://git.laquadrature.net/lqdn-interne/piops-roles/don-lqdn), que vous pouvez lire directement dans le dossier `ansible/`
+
 ## Développement

+### Documentation
+
+Vous pouvez consulter la documentation relative au développement et au déployement de ce site web dans le dossier `doc/` ou en [cliquant ici.](doc/README.md)
+
 ## Contributions

 Les contributions sont bienvenues ! Pour commencer, vous pouvez regarder les tickets ouvert sur le dépôt. Certaines sont marqués comme étant "besoin d'aide", et ne demandent que vous pour être résoluts !
 @@ -45,93 +69,4 @@ Vous pouvez ensuite ouvrir une merge request, et une fois relue, elle sera mise

 ----

-
-# LQDN soutien
-
-This is a php application based on Fat-Free-Framework and a MySQL database that handles donations and presents offered to donors to La Quadrature du Net
-
-It's used as our primary donation platform, and uses our bank's payment system (cheaper) to get one-time or recurring payments recorded into the donation platform.
-
-## Environnement de test
-
-Afin de faciliter la réalisation de tests, vous pouvez utiliser Vagrant et Ansible à travers le rôle `don-lqdn`.
-
-Pour la mise en place ;
-
- Mise en place de la machine virtuelle ; téléchargement d'une machine virtuelle Debian.  
-    - `$ vagrant up`
- Installation du site de don ; Installation du rôle don-lqdn dans la machine virtuelle
-    - `$ vagrant provision`
- Vous pouvez maintenant voir le site de don sur `http://192.168.56.42:8000/`.
-
-Les modifications faites dans ce dossier sont reportés directement dans la machine virtuelle, dans son dossier `/vagrant`.
-
-Vous pouvez modifier ceci en éditant le fichier `Vagrantfile` et les fichiers dans le dossier `ansible/`.
-
-## Installation (quick)
-
-In order to install this project, run `make doctor` to check that everything is fine.
-
-Then you can run `make install` to install the project. Follow instructions if needed.
-To install the DB, you need to run `make reset-db` (it will remove your local DB if it exists).
-
-Once everything if fine, you can run a simple PHP server with `make server-start`
-
-You have those accounts to test:
-
-* alice@example.org / password
-* bob@example.org / password
-
-To access to the admin (`/admin`) use `admin`/`password`
-
-## Contributing
-
-Before submitting a PR, makes sure tests are OK: `make test`
-
-# Detailed dependencies, installation ...
-
-## Dependencies
-
-This software depends on a few software :
-
-* **composer** (to install php dependencies) see https://getcomposer.org/
-* a **mysql client** (to inject the database schema)
-* a **mysql server** (no need for it to be local)
-* **pdftk** to generate pi-plomes (pdf with pi's decimals offered to our donors)
-* **texlive-latex-base** for the `pdflatex` binary for the piplomes (only required in production or for people debugging the piplomes code)
-
-and for developers you may also need :
-
-* **xgettext** to manage translations, use:
-  * `make messages.pot` to update PO files from source code.
-  * `make translations` to compile MO files from PO files when translations are ready.
-
-This software uses:
-
-* **PHP7.3**
-* **phinx** to inject database schema and initial data / accounts into MySQL see https://phinx.org/
-* **php-cs-fixer** to check php code for errors and fix coding standard issues, see https://github.com/FriendsOfPHP/PHP-CS-Fixer
-* **doctrine/dbal** as ORM see https://github.com/doctrine/dbal
-* **f3 framework** as main view / controller framework. see https://fatfreeframework.com/
-
-Look at `app/` folder for most Controllers, and `app/routes.ini` for the application routes (the URLs)
-
-# Production deployment (not finished)
-
-* `app/env` must contains the proper values : database connection, bank visa payment codes, and ENV=production at the bottom.
-* point your Nginx or Apache with PHP5.6 to the `www/` folder, and either allow Rewrite Rules (a2enmod rewrite) or point every URL not being a file to index.php (see below for an nginx sample)
-* use AND FORCE https usage, it's 2018, people ;)
-
-Nginx configuration sample:
-
-```
-location ~ \.php$ {
-    include fastcgi_params;
-    fastcgi_read_timeout 1d; #avoid timeout when importing bank data
-    fastcgi_pass unix:/run/php7.3.sock;
-}
-location / {
-   # try to serve file directly, fallback to index.php
-   try_files $uri /index.php$is_args$args;
-}
-```			
+[ 🇬🇧 Read the english version by clicking this link.](README.en.md)