diff --git a/README.md b/README.md index 4099df2557f22decfa57914498b887f6d0a218ce..7e4480c7e5f64f2877971ce2533d3761130fb0b6 100644 --- a/README.md +++ b/README.md @@ -50,71 +50,6 @@ Vous pouvez en suite créer votre présentation: plz build :ma_presentation ``` -Vous devriez avoir ceci : - -- BUILD -- ma_presentation/ - - index.md - -## Avec intégration continue - -# Détails - -## Outils utilisés - -Le projet reconstruit le framework reveal.js à partir des sources en utilisant -[minify](https://github.com/tdewolff/minify) et [sass-dart](https://github.com/sass/dart-sass) -pour traiter les fichiers. Il ajoute au passage le thème INRAE avec les images et polices nécessaires. - -Tous les outils sont téléchargés automatiquement, avec vérification de hash. - -[reveal.js](https://github.com/hakimel/reveal.js) est un framework pour -construire des présentations HTML. - -- Un navigateur est suffisant pour l'afficher. -- Contenu écrit en HTML et/ou en [Markdown](https://fr.wikipedia.org/wiki/Markdown) -- Ce n'est pas WYSIWIG. - -## pandoc - -[pandoc](https://pandoc.org/) est un convertisseur de document d'un language -de markup vers un autre. - -En l'occurence, il peut être utilisé pour générer le contenu d'une [présentation -reveal.js](https://pandoc.org/MANUAL.html#producing-slide-shows-with-pandoc) -à partir de fichiers [Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown). - -## [pole-is/tools/reveal.js](https://gitlab.irstea.fr/pole-is/tools/reveal.js) - -Fournit : - -- une version de reveal.js intégrant un thème INRAE (circa 2020), -- des scripts basés sur le système de construction [Please](https://please.build/), -- de la configuration pour générer automatiquement les présentations avbec Gitlab-CI, - voire les publier automatiquement avec Gitlab-Pages. - -# Utilisation - -## En local (Linux) - -- [Installez Please](https://please.build/quickstart.html) -- Créez un dossier pour votre présentation. -- Installez-y le script de build Please [sample.BUILD](sample.BUILD) et renommez le en `BUILD` -- Créez un dossier pour le contenu de votre présentation, e.g. `ma_presentation` (éditez - le fichier BUILD si vous changez le nom du répertoire) avec un fichier pour les slides `index.md`. - -Vous pouvez en suite créer votre présentation: - -```bash -plz build :ma_presentation -``` - -Vous devriez avoir ceci : - -- BUILD -- ma_presentation/ - - index.md - ## Avec intégration continue # Sous le capot @@ -126,6 +61,6 @@ Vous devriez avoir ceci : Les outils suivants sont téléchargés et vérifiés automatiquement par Please : - reveal.js: https://github.com/hakimel/reveal.js -- sass-dart: https://github.com/sass/dart-sass +- dart-sass: https://github.com/sass/dart-sass - minify: https://github.com/tdewolff/minify - pandoc: https://github.com/jgm/pandoc