Add French translation of quickstart.md

1 files changed, 92 insertions, 0 deletions

diff --git a/doc/quickstart.fr.md b/doc/quickstart.fr.md
new file mode 100644
index 0000000..f4b1b7c
--- /dev/null
+++ b/doc/quickstart.fr.md
@@ -0,0 +1,92 @@
+# Démarrer rapidement avec Comitium
+
+Comitium est construit pour être très simple à installer et utiliser, même sur
+des solutions d'hébergement mutualisées sans accès root. Seul un serveur gemini
+capable de servir des fichiers statiques est nécessaire ainsi que la possibilité
+de lancer des planifiées tâches (cron).
+
+## installation
+
+Des binaires pré-construits sont disponibles ici [https://nytpu.com/releases/comitium/](https://nytpu.com/releases/comitium/).
+
+Pour construire manuellement comitium:
+Si vous pouvez écrire dans `/usr/local/`, vous pouvez simplement suivre les
+instructions, y compris `make install` sur le [README][]. Si vous n'avez accès
+qu'à votre répertoire personnel, vous pouvez utiliser le binaire construit et la
+page de manuel dans `build/` après avoir exécuté `make`. Vous pouvez ensuite
+copier ou créer un lien symbolique du binaire comitium vers votre répertoire
+bin préféré et accéder à la page de manuel avec `man -l build/comitium.1`.
+
+[README]: ../README.md
+
+## Configuration
+
+### Stockage des données
+
+Une fois que vous avez configuré le binaire, vous devez déterminer où vous
+souhaitez que les données soient stockées. Si votre capsule se trouve dans
+`~/public_gemini` ou équivalent (votre utilisateur principal a accès au
+répertoire), indiquez simplement `export COMITIUM_DATA="~/public_gemini"` dans
+le fichier rc de votre shell et les fichiers y seront générés.
+
+Si votre capsule se trouve dans `/var/gemini` ou équivalent (votre utilisateur
+principal n'a pas accès au répertoire), il est préférable d'utiliser votre
+répertoire par défaut et d'utiliser un lien symbolique `feeds.gmi` et
+`subscriptions.gmi` dans le dossier concerné. De cette façon, comitium n'a pas
+besoin d'être exécuté en root, aucune permission système sont nécessaire et pas
+de connexion à un utilisateur gemini pour ajouter un flux.
+
+### Ajouter un flux
+
+Il faut maintenant ajouter des flux à vos abonnements. Si vous n'avez pas de
+liste existante de flux, il suffit d'un simple `comitium add <url>` pour
+ajouter un nouveau flux (voir [`man comitium`][man] pour plus de détails sur la
+commande `add`). Il est inutile d'utiliser la commande `comitium refresh` après
+`add`, cette dernière ira récupérer les éléments du nouveau flux et mettra à
+jour les fichiers .json et .gmi avec les nouvelles entrées.
+
+Si vous avez une liste existante de flux, il est assez trivial (pour la plupart
+des formats :P) d'écrire un script shell ou similaire pour extraire les
+différentes url et exécuter `comitium add` pour chacune d'elle.
+
+[man]: comitium.1.scd
+
+### Configurer l'en-tête
+
+Vous pouvez personnaliser l'en-tête de votre `feed.gmi`. Pour cela, créez
+simplement un fichier `header.gmi` dans le répertoire gemini (où se trouvent les
+fichiers `comitium.json`, `feed.gmi` et `subscriptions.gmi`) et indiquez votre
+contenu personnalisée. Le lien de résumé indiquant le nombre d'abonnements à la
+page `subscriptions.gmi` sera placée après le contenu de `header.gmi`, séparé
+par une nouvelle ligne.
+
+Par exemple, si le fichier `header.gmi` contient:
+
+```
+# mon agregateur
+```
+
+alors le rendu final de `feed.gmi` contiendra:
+
+```
+# mon agregateur
+
+=> subscriptions.gmi X capsules, gopherholes et sites internet sont agrégés.
+
+Generé le ...
+```
+
+### Mise à jour régulière
+
+Une simple ligne dans `crontab` suffit, par exemple pour une actualisation
+toutes les 6 heures:
+```
+0 */6 * * * /usr/local/bin/comitium refresh
+```
+
+Si vous utilisez une variable d'environnement pour définir le répertoire gemini
+comme indiqué précédemment, celle ci ne sera pas utilisée par `cron`, il faudra
+donc indiquer le chemin vers le répertoire gemini, par exemple:
+```
+0 */6 * * * /home/somebody/bin/comitium refresh -d /home/somebody/public_gemini
+```