From 2cc87d878f513114e706f0b0406ccfc601a5baed Mon Sep 17 00:00:00 2001
From: Gabriel Augendre <gabriel@augendre.info>
Date: Sat, 21 Aug 2021 09:07:27 +0200
Subject: [PATCH] Translate & improve readme

---
 .gitignore |  1 +
 README.md  | 73 +++++++++++++++++++++++++++++++++++++++++++++++++++---
 2 files changed, 70 insertions(+), 4 deletions(-)

diff --git a/.gitignore b/.gitignore
index 4b0d365..d564659 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,4 @@
+insee_number_translator
 
 # Created by https://www.gitignore.io/api/pycharm,python
 # Edit at https://www.gitignore.io/?templates=pycharm,python
diff --git a/README.md b/README.md
index 9f34ec8..effa952 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,69 @@
-# INSEE number translator
+# INSEE number translator (Français)
+(English below)
+Extrait les données des numéros INSEE (numéro de sécurité sociale française).
 
-Extract data from INSEE number (France)
+Le numéro de sécurité sociale français est *signifiant*. Cela veut dire que ce n'est pas un numéro aléatoire,
+il porte des informations.
+
+* https://www.insee.fr/fr/metadonnees/definition/c1409
+* https://fr.wikipedia.org/wiki/Num%C3%A9ro_de_s%C3%A9curit%C3%A9_sociale_en_France
+
+## Commencer
+### Utiliser un programme prêt à l'emploi
+Rendez-vous sur la [dernière version](https://git.augendre.info/gaugendre/insee_number_translator/releases/latest)
+et téléchargez le fichier correspondant à votre système d'exploitation et à votre architecture.  
+Si vous ne savez pas de quoi il s'agit, essayez d'abord `amd64` puis `386` si le premier ne fonctionne pas.  
+Pour macOS, utilisez le fichier `darwin`.
+
+Ensuite, utilisez la ligne de commande pour exécuter le fichier :
+```shell
+./insee 269059913116714 168127982980507 299122A00498723 299129742398791 144089943287340
+```
+
+Rassurez-vous, ce programme ne transmet aucune information sur le réseau. Toutes les données
+nécessaires à son fonctionnement sont comprises dans le fichier que vous venez de télécharger.  
+Votre numéro de sécurité sociale ne quitte pas votre ordinateur.
+
+### Depuis les sources
+Requiert les outils `go` (https://golang.org/).
+
+#### Exécution directe
+```shell
+go run . 269059913116714 168127982980507 299122A00498723 299129742398791 144089943287340
+```
+
+#### Compilation et installation
+```shell
+go install
+insee_number_translator 269059913116714 168127982980507 299122A00498723 299129742398791 144089943287340
+```
+
+# INSEE number translator (English)
+Extract data from INSEE number (France).
+
+The french social security number is significant. That means it's not a random number, it bears information.
+
+* (fr) https://www.insee.fr/fr/metadonnees/definition/c1409
+* (fr) https://fr.wikipedia.org/wiki/Num%C3%A9ro_de_s%C3%A9curit%C3%A9_sociale_en_France
 
 ## Getting started
 ### Using a pre-built binary
 Go to the [latest release](https://git.augendre.info/gaugendre/insee_number_translator/releases/latest)
-and download the binary matching your OS and architecture.
+and download the binary matching your OS and architecture.  
+If you don't know what that means, try `amd64` first, then `386` if it doesn't work.  
+For macOS, choose `darwin`.
 
 Then, run the tool via the command line:
 ```shell
 ./insee 269059913116714 168127982980507 299122A00498723 299129742398791 144089943287340
 ```
+Rest assured, this program doesn't transmit any information on the network. All the data
+necessary for its operation are included in the file you just downloaded.  
+Your social security number doesn't leave your computer.
 
 ### From sources
+Requires the `go` toolchain (https://golang.org/).
+
 #### Run
 ```shell
 go run . 269059913116714 168127982980507 299122A00498723 299129742398791 144089943287340
@@ -24,6 +75,20 @@ go install
 insee_number_translator 269059913116714 168127982980507 299122A00498723 299129742398791 144089943287340
 ```
 
-## Data sources
+# Tinker
+## Update data
+You can easily update the data by downloading the CSV files available using the link in `Data sources` below.
+Then, unzip the file in `data/raw_data` and run the following command:
+
+```shell
+invoke pre-process
+```
+
+This requires [`invoke`](https://www.pyinvoke.org/) on your machine.
+
+## Release
+Create a tag using `inv tag <tag_name>`, then run `inv build <tag_name>` to build the binaries.
+
+# Data sources
 
 * https://www.insee.fr/fr/information/2560452, Millésime 2021 : Téléchargement des fichiers, CSV