add README

README.adoc

+= Cours de Test Logiciel (M1ALMA)
+
+== Organisation du code
+
+Le site web est défini est construit à l'aide du logiciel https://antora.org/[Antora], une solution permettant d'écrire une documentation structurée en nombreuses page et écrites en https://docs.asciidoctor.org/asciidoc/latest/[Asciidoc].
+
+Le contenu des pages est défini dans le répertoire `src`, qui comporte lui-même un certain nombre de liens symboliques vers des sous-répertoires de `course-assets`.
+`course-assets` est un submodule git qui pointe vers https://gitlab.univ-nantes.fr/gl/testing/course-assets[un second dépôt git du même nom] (utilisé pour mutualiser le contenu "brut"" du cours entre deux formations).
+
+== Compiler et tester localement
+
+La recette de build n'est défini que dans une pipeline Gitlab (fichier `.gitlab-ci.yml`), donc il est recommandé d'utiliser la commande https://github.com/firecow/gitlab-ci-local/[`gitlab-ci-local`] pour compiler localement :
+
+```
+$ git clone --recurse-submodules https://gitlab.univ-nantes.fr/gl/testing/course-m1alma.git
+$ cd course-m1alma
+$ gitlab-ci-local
+```
+
+Cela créera in fine un répertoire `public` qui contient tout le site web compilé.
+De là, on peut lancer un petit serveur web avec l'outil de son choix pour visualiser le contenu.
+Par exemple en utilisant la commande https://www.npmjs.com/package/live-server[`live-server`]
+
+
+```
+$ cd public
+$ live-server
+```
+
+Puis il suffit d'accéder à http://127.0.0.1:8080.
+
+== Contribuer
+
+Tout dépend de la section du cours :
+
+- Pour contribuer sur la parties _organisation_ du cours, on peut directement modifier link:src/organisation[les fichiers source correspondants] stockés dans ce dépôt.
+- Pour contribuer sur les parties cours ou TP, les commits sont à réaliser dans https://gitlab.univ-nantes.fr/gl/testing/course-assets[le dépôt assets]. 
+Puis, dès que de nouveaux commits ont été réalisés sur le dépôt asset, il faut faire un commit sur ce dépôt pour pointer vers le dernier commit du dépôt assets.
+
+[TIP]
+====
+Pour fluidifier le développement, on peut directement faire des commits vers le dépôt asset depuis le submodule du présent dépôt.
+Pour cela, il faut juste, après avoir fait le `git clone --recurse-submodules`, se rendre dans le répertoire `course-assets`, et changer l'URL cible pour mettre l'adresse SSH :
+
+```
+$ cd `course-assets`
+$ git remote set-url origin git@gitlab.univ-nantes.fr:gl/testing/course-assets.git
+```
+====
\ No newline at end of file