diff --git a/README.md b/README.md index e17c2f2e0f7915efc949cb21ecdd626ef465aac7..ad81a10f9ef5663f9c71cdc94373bc1266e69b07 100644 --- a/README.md +++ b/README.md @@ -19,34 +19,34 @@ TODO before publication: - [x] translate 404 -# Site web de Duniter +# Duniter website -Ce site est réalisé en Zola et sert de support technique pour présenter et utiliser le logiciel Duniter. Il présente également les concepts de bases d'une monnaie libre et du fonctionnement de la monnaie ğ1. +This site is built with Zola and serves as technical support to present and use the Duniter software. It also introduces the ground concepts of libre money and the workings of the ğ1 currency. -## Utilisation +## Usage -Pour modifier le site localement, veuillez d'abord cloner le dépôt : +To modify the site locally, start by cloning the repo: ``` git clone https://git.duniter.org/websites/duniter_website_fr_v2.git ``` -La plupart des composants sont directement inclus, mais certains comme Forkawesome (pour les icones) sont disponibles comme sous-module git. Vous pouvez les ajouter avec : +Most of the components are included, but certain ones like Forkawesome (for icon fonts) are available as git submodules. You may include them with: ``` git submodule init git submodule update ``` -Après avoir installé [Zola](https://www.getzola.org/documentation/getting-started/installation/), lancez dans le dossier principal : +After installing [Zola](https://www.getzola.org/documentation/getting-started/installation/), run this in the working copy's root folder: ``` zola serve ``` -et cliquez sur le lien [http://127.0.0.1:1111](http://127.0.0.1:1111) pour consulter le site localement (rafraîchi automatiquement en cas de modification). +and click on the link [http://127.0.0.1:1111](http://127.0.0.1:1111) to check out the site locally (it auto-reloads upon changes). -Pour mettre à jour la documentation automatiquement depuis le gitlab, veuillez exécuter le script dédié (au stade de prototype, peut casser à tout moment) : +To update the docs automatically from the git content, run the purpose-built script (be aware it's a prototype and may fail) : ``` pip install toml @@ -55,8 +55,8 @@ pip install toml ## Vue d'ensemble -La plupart du contenu du site est situé dans dans le dossier `content` sous forme de fichiers Markdown (texte amélioré) avec des métadonnées en en-tête. Les fichiers statiques (images, documents) sont pour la plupart dans le dossier `static`, une grande partie étant dans le dossier `PELICAN`, issu de la migration du site initial. Le thème est constitué de fichiers html utilisant un langage de template situés dans le dossier `templates`. Enfin, certaines feuilles de style sont rédigées en sass (css amélioré) dans le dossier `sass` alors que d'autres sont écrites en css et situés avec les fichiers statiques. +Most of the site's content lives in the folder `content` as Markdown (rich text) files, with metadata headings. Static files (images, documents) live for the most part under `static`, a large subset under `PELICAN`, a folder resulting from the migration of the initial site. The theme consists of templated html files that live under `templates`. Finally, some stylesheets are written in sass (a superset of css) in the `sass` folder, while others are written in plain css and live alongside the static files. -## Contribuer +## Contribute -Pas besoin d'être à l'aise avec `git`, `zola`, `html`, `css`, `javascript`, `markdown` pour contribuer simplement. Il vous suffira de suivre le [guide de contribution](./doc/README.md). \ No newline at end of file +In order to simply contribute, there is no need to be familiar with `git`, `zola`, `html`, `css`, `javascript`, `markdown`. It will suffice to follow the [contribution guide](./doc/README.md). diff --git a/content/software/gcli.md b/content/software/gcli.md index d48c8f55c31f627f5ed06aab287da43a5e64a802..98ce8ff035d64aedb7da707b787b57b9e122f812 100644 --- a/content/software/gcli.md +++ b/content/software/gcli.md @@ -13,4 +13,4 @@ website = "" +++ -<a href="https://git.duniter.org/clients/rust/gcli">Ğcli</a> is a comment line GVA client written in <strong>Rust</strong>. +<a href="https://git.duniter.org/clients/rust/gcli">Ğcli</a> is a command line GVA client written in <strong>Rust</strong>.