commit f19a2ae0e702d310aa7c643a48ebcb8838ad4503
parent e75119a8a1a5a76546f18f917eb429dca3aa1a9e
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Thu, 24 Feb 2022 16:09:47 +0100
Add a README.md file (in french)
Diffstat:
| A | README.md | | | 101 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 101 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,101 @@
+# Meso-Web
+
+Meso-Web contient l'ensemble des ressources du site web de Meso-Star ainsi que
+la chaîne de génération automatique qui construit ledit site à partir de ces
+ressources. Les ressources en question regroupent non seulement du texte _HTML_
+et des images, mais aussi des archives, scripts et documents proposés au
+téléchargement.
+
+## Télécharger les sources de Meso-Web
+
+Meso-Web utilise _git_ et [git-fat](https://github.com/Jwink3101/git-fat) pour
+versionner, respectivement, ses fichiers textes et ses ressources binaires.
+Copier localement l'ensemble du contenu Meso-Web se ramène d'abord à cloner son
+dépôt _git_ avant d'utiliser _git-fat_ pour télécharger ses binaires. En
+assumant que _git_ et _git-fat_ sont installés et que Meso-Web est hébergé à
+l'adresse hôte "nastar" sous le dépôt "repo/meso-web.git", copier localement
+Meso-Web revient donc à entrer les commandes suivantes :
+
+ ~ $ git clone nastar:meso-web.git
+ ~ $ cd meso-web
+ ~/meso-web $ git-fat init
+ ~/meso-web $ git-fat pull
+
+## Générer le site web
+
+La chaîne de génération automatique de Meso-Web s'appuie sur des fichiers
+_Makefile_ et des scripts _shell_ qui, dans un souci de portabilité, suivent la
+norme _POSIX_. Pour construire le site web il faut donc au préalable installer
+une mise en oeuvre de la commande _make_ compatible _POSIX_ tel que, [GNU
+make](https://www.gnu.org/software/make/manual/make.html) ou
+[bmake](http://www.crufty.net/help/sjg/bmake.html), et un interpréteur de
+commande pour le _shell_ _POSIX_, comme
+[GNU Bash](https://www.gnu.org/software/bash/) ou [Z
+shell](https://zsh.sourceforge.io/). Au delà de _make_ et des commandes
+_shell_, d'autres programmes sont utilisés par la procédure de génération
+automatique de Meso-Web comme [GNU Privacy Guard](https://gnupg.org/) pour
+signer numériquement les archives proposées au téléchargement ou _rsync_
+utilisé pour déployer le site web. D'aucun pourra exécuter le script _shell_
+_configure.sh_ pour vérifier que l'ensemble de ces commandes additionnelles
+sont bien installées sur le système :
+
+ ~/meso-web $ ./configure.sh
+
+En assumant que l'ensemble des pré-requis sus-cités sont bien remplis, générer
+le site web consiste simplement à invoquer la commande _make_ à la racine de
+Meso-Web :
+
+ ~/meso-web $ make
+
+## Vérifier la conformité des fichiers _HTML_ et des scripts _shell_
+
+La fichiers _Makefile_ proposent la cible _check_ pour vérifier la conformité
+des fichiers _HTML_ générés. Son objet est de s'assurer que les pages ainsi
+construites s'afficheront correctement sur n'importe quel navigateur respectant
+la norme _HTML_. En plus de vérifier les pages web, la cible _check_ vérifie
+également les sources des scripts _shell_ utilisés pour générer ces pages :
+
+ ~/meso-web $ make check
+
+## Supprimer les fichiers issus de la génération automatique
+
+Deux cibles _Makefile_ permettent de supprimer les fichiers générés à
+l'invocation de la commande _make_. La cible _clean_ supprime essentiellement
+les fichiers _HTML_ générés :
+
+ ~/meso-web $ make clean
+
+La cible _distclean_ supprime en plus les fichiers qui ont été plus long à
+obtenir tels que les signatures numériques des archives binaires, ou encore des
+fichiers extraits de ces archives et utilisés comme sources lors de la
+génération des pages _HTML_. _distclean_ est en quelque sorte un _clean_
+renforcé qui, à la prochaine invocation de la commande _make_, force à rejouer
+entièrement la procédure de génération automatique :
+
+ ~/meso-web $ make clean
+
+## Déployer le site web
+
+La cible _install_ des fichiers _Makefile_ permet de déployer le site web à
+l'addresse renseignée par la macro _PREFIX_ définie dans le fichier
+"config.mk". On prendra donc le soin de définir cette variable à l'adresse
+souhaitée avant d'appeler _make install_ ou de la redéfinir à l'invocation de
+cette commande. Par exemple, pour déployer localement le site web dans le
+répertoire _/tmp_, on entrera la commande suivante :
+
+ ~/meso-web $ make PREFIX=/tmp install
+
+## Licence
+
+Copyright © 2017-2022 |Meso|Star> (<contact@meso-star.com>)
+
+Meso-Web est un logiciel libre ; vous pouvez le redistribuer ou le modifier
+suivant les termes de la GNU General Public License telle que publiée par la
+Free Software Foundation ; soit la version 3 de la licence, soit (à votre gré)
+toute version ultérieure. Ce programme est distribué dans l'espoir qu'il sera
+utile, mais SANS AUCUNE GARANTIE ; sans même la garantie tacite de QUALITÉ
+MARCHANDE ou d'ADÉQUATION à UN BUT PARTICULIER. Consultez la GNU General Public
+License pour plus de détails. Vous devez avoir reçu une copie de la GNU General
+Public License en même temps que ce programme ; si ce n'est pas le cas,
+consultez <http://www.gnu.org/licenses>.
+
