diff --git a/www/CONTRIBUTING.md b/www/CONTRIBUTING.md index c11d2b6b..151f1482 100644 --- a/www/CONTRIBUTING.md +++ b/www/CONTRIBUTING.md @@ -1,29 +1,120 @@ -# Contributing to the Ergo‑L website - -## Setup - -### For Windows - -* Open a terminal, for example Windows PowerShell -* Install [Hugo](https://gohugo.io/installation/windows/) : - ```powershell - winget install Hugo.Hugo.Extended - ``` -* Optional if you run Hugo in a Linux terminal such as WSL or Git Bash ; install [PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.4) (Hugo can’t run in preinstalled Windows PowerShell) : - ```powershell - winget install --id Microsoft.Powershell --source winget - ``` - Note : PowerShell is not [the same application](https://learn.microsoft.com/en-us/powershell/scripting/whats-new/differences-from-windows-powershell?view=powershell-7.3) as _Windows_ PowerShell even if the name is almost the same and they are both maintained by Microsoft -* Install [Pandoc](https://pandoc.org/installing.html#windows) : - ```powershell - winget install --source winget --exact --id JohnMacFarlane.Pandoc - ``` -* Launch the newly installed PowerShell (or restart it if you already had it) and go to the `www` folder : - ```powershell - cd www - ``` -* Run the development server : - ```powershell - hugo server - ``` -* And go to http://localhost:1313/ to see the effect of your changes in livereload \ No newline at end of file +Contribuer au site Web Ergo‑L +================================================================================ + + +Prérequis : Hugo + Pandoc +-------------------------------------------------------------------------------- + +### Windows + +Installer [Hugo] et [Pandoc] depuis un émulateur de terminal, par exemple +Windows PowerShell : + +```powershell +winget install Hugo.Hugo.Extended +winget install --source winget --exact --id JohnMacFarlane.Pandoc +``` + +Attention : Hugo ne fonctionne pas depuis le terminal Windows PowerShell qui est +préinstallé. + +Hugo requiert un terminal WSL, Git Bash ou [PowerShell] tout court, [qui n’est +pas la même application que Windows PowerShell][WindowsPS], bien que le nom soit +quasiment le même et que les deux applications soient maintenues par Microsoft. +PowerShell peut s’installer depuis Windows PowerShell : + +```powershell +winget install --id Microsoft.Powershell --source winget +``` + +[Hugo]: https://gohugo.io/installation/windows/ +[Pandoc]: https://pandoc.org/installing.html#windows +[PowerShell]: https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows +[WindowsPS]: https://learn.microsoft.com/en-us/powershell/scripting/whats-new/differences-from-windows-powershell + + +Serveur de développement +-------------------------------------------------------------------------------- + +On lance le serveur de développement via un émulateur de terminal depuis ce +répertoire `www` : + +```bash +cd www +hugo serve +``` + +Le site est alors visible sur . + +Le site est mis à jour à chaque modification de fichier +(live-reload). + + + +Rédaction +-------------------------------------------------------------------------------- + +### Markdown + +Les pages sont écrites en [Pandoc Markdown] plutôt qu’en HTML chaque fois que +c’est possible. + +Les lignes sont limitées à 80 caractères. + +Les titres de niveau 1 et 2 sont marqués par un soulignement de 80 signes `=` et +`-` respectivement (en-tête Setext). Les titres de niveau supérieur sont +indiqués par des `#` (en-tête ATX), mais on évitera d’utiliser les niveaux +supérieurs à 3. + +Pour les liens, on privilégie les URL dans une référence de bas de page plutôt +que dans le corps du texte, afin de faciliter la lecture. + +### Orthographe + +On suit l’orthographe de la [réforme de 1990]. Il existe des dictionnaires +dédiés, et des outils comme Wiktionnaire indiquent les variantes. + +Par souci d’inclusivité, on privilégie les formules [épicènes]. Les formes +condensées avec le point médian sont tolérées mais gagnent à être évitées. +L’[accord de proximité] est encouragé. + +### Typographie + +On utilise l’insécable fine avant toutes les ponctuations hautes (`?!:;`) et +à l’intérieur des guillemets (`« »`). + +Les incises sont délimitées par des tirets cadratins (—), sans insécables. + +### Nombres + +Les nombres utilisent l’insécable fine comme séparateur de milliers et d’unité. +Le séparateur décimal est la virgule. + +### Termes anglophones + +On évite les mots anglais dans le texte, et quand on y a recours on veillera à +les inclure dans une balise `` pour l’accessibilité (lecteurs +d’écran). + +Les termes techniques courants en anglais sont tolérés — notamment tous ceux qui +sont définis dans le glossaire. + +### Désignation des touches + +Les touches physiques sont incluses dans des balises ``, les caractères +produits dans des balises ``. On parle donc de la touche F pour +désigner celle qui produit un `N` en Ergo‑L. + +Comme on n’a pas encore de règle pour désigner les touches spéciales, l’usage +actuel mélange les termes anglais et français : Shift, +Entrée, Backspace, Esc, etc. Une possibilité +serait de s’appuyer sur des normes existantes telles que [w3c] ou [USB HID]. + + +[épicènes]: https://fr.wiktionary.org/wiki/épicène +[accord de proximité]: https://fr.wikipedia.org/wiki/Règle_de_proximité +[réforme de 1990]: https://fr.wikipedia.org/wiki/Rectifications_orthographiques_du_français_en_1990 + +[Pandoc Markdown]: https://pandoc.org/MANUAL.html#pandocs-markdown +[USB HID]: https://www.usb.org/sites/default/files/hut1_5.pdf +[w3c]: https://w3c.github.io/uievents-code/#key-alphanumeric-writing-system