From 9d3ccc75080d036e4ecc7db95e612cbf17ee9f2a Mon Sep 17 00:00:00 2001 From: hellekin Date: Wed, 25 May 2022 16:48:21 +0200 Subject: Update README file for 2022 --- README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 52 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 01e2ddb..c2ef885 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,10 @@ Ce dossier comporte les éléments des sites hébergés sur [lesoiseaux.io]: - **assets/** () - les éléments statiques de style, fontes et images utilisés par + les éléments statiques de style, polices de caractères et images utilisés par l'ensemble des sites. - **ps/** () - le site principal de Petites Singularités + le site principal des petites singularités - **www/** () le site _Wholeheartedly Wonderful Will_ qui sert de présentation aux projets artistiques issus de _Quantify Wholeheartedly_. @@ -25,7 +25,7 @@ Ce dossier comporte les éléments des sites hébergés sur ## Conditions d'utilisation -Copyright © 2017 Petites Singularités. +Copyright © 2017-2022 petites singularités. Le code source est du logiciel libre, disponible sous licence GNU Affero General Public License version 3. @@ -33,15 +33,61 @@ Affero General Public License version 3. Les éléments graphiques, de style ainsi que les contenus des différents sites sont disponibles sous licence Art Libre version 1.3. -Une copie de ces licences est disponible dans le fichier LICENSE. +Une copie de ces licences est disponible dans le dossier [LICENSES]. + +[LICENSES]: ./LICENSES ## Contribuer -Les patches sont bienvenus ! +Les _patches_ sont bienvenus ! Vous pouvez consulter le code source à . Les discussions autour du code et des contenus se font par l'intermédiaire de notre plate-forme de conversation basée sur -Discourse et disponible à . +Discourse et disponible à . + +-> + +### Modifier le style + +[`sassc`] permet de convertir les fichiers [SASS] en CSS de manière optimale. + +Bien que [`ruby-sass`] soit officiellement « décédé », il offre l'option +`--watch` qui permet la compilation automatique des fichiers SASS en CSS durant +le développement, et accepte des répertoire comme INPUT et OUTPUT : cela est +appréciable. + +[`sassc`]: https://github.com/sass/sassc +[`ruby-sass`]: https://sass-lang.com/ruby-sass + +On trouvera donc avantage à utiliser `ruby-sass` durant le développement : + +``` +cd lesoiseaux.io/assets +sass --watch scss css +``` + +TODO: utiliser plutôt une autre solution pour repérer les changement, avec `inotify` ou `Guard`... + +La compilation des feuilles de style en production pourra se faire avec `sassc` : + +``` +for style in home mobile screen txt www; do + sassc -t compressed -m scss/$style.scss css/$style.css +done +``` + +TODO: utiliser un pre-commit hook + +### Modifier le contenu + +Merci de discuter les changement [sur le forum] et/ou de fournir un _patch_ intelligible (c'est-à-dire : lisible et simple à comprendre). Des changements trop importants pourront être refusés. +Merci également de suivre ce qui existe déjà : HTML5, usage de l'attribut `lang`, minimalisme, etc. + +Les rapports d'erreurs doivent se faire [sur le forum] : nous tâcherons de les corriger au mieux. + +Merci de votre contribution ! + +[sur le forum]: https://ps.zoethical.org/t/a-propos-du-site-des-petites-singularites/5793 -- cgit v1.2.3