Initial commit

.github/ISSUE_TEMPLATE/🪄-améliorations.md

@@ -0,0 +1,20 @@
+---
+name: "\U0001FA84 Améliorations"
+about: Vous avez une idée pour améliorer ce support ? C'est pas ici !
+title: "[ \U0001FA84 Améliorations ] "
+labels: enhancement
+assignees: Alex-Octocorn
+
+---
+
+## Description
+
+<!-- Précisez ici en quelques mots comment nous pouvons améliorer ce support -->
+
+## Précisions
+
+<!-- 
+S'il s'agit d'un nouveau chapitre, précisez son plan de cours  
+N'hésitez pas à utiliser les checkbox pour faciliter l'implémentation de vos améliorations ! :)
+
+-->

.github/ISSUE_TEMPLATE/🪲-correction.md

@@ -0,0 +1,33 @@
+---
+name: "\U0001FAB2 Correction"
+about: 'Vous avez remarqué une erreur, ou une incohérence ? '
+title: "[\U0001FAB2 Bug ] "
+labels: bug
+assignees: Alex-Octocorn
+
+---
+
+## Description
+
+<!-- Précisez ici dans les grandes lignes ce qui doit être corrigé -->
+
+## Reproduire
+
+<!--
+ Indiquez nous comment reproduire l'erreu.
+Pensez à préciser le numéro de la slide !
+ 
+- Step 1
+- Step 2
+- ...
+-->
+
+## Corriger
+
+<!-- 
+Quel est la correction à apporter ?
+  -->
+
+## Informations complémentaires
+
+<!-- Tout ce qui peut être utile ! -->

.github/pull_request_template.md

@@ -0,0 +1,27 @@
+## Description de la PR
+
+<!-- 
+Décrivez ici les modifications apportées par votre PR 
+Si votre PR est encore en cours, pensez à la marquer comme "Draft"
+-->
+
+## Tasks
+
+<!-- Si pertinent, précisez ici la référence de l'issue associée à votre PR -->
+<!-- Exemple : #1 -->
+
+## Progress
+
+<!-- Sous forme de checklist, précisez ici les tâches réalisées ou en cours de réalisation -->
+
+## Definition of Done
+
+<!-- Votre PR est-elle prête à être mergée ? -->
+
+- [ ] Si pertinent, j'ai ajouté au moins un exercice associé à mon chapitre
+- [ ] J'ai vérifié l'orthographe et la grammaire !
+- [ ] J'ai ajouté mon chapitre à l'index `./cours/00_index.slides.md`
+- [ ] J'ai ajouté un lien vers l'index à la fin de mon chapitre : `---` puis `# La suite !` puis `- [Index](index.html)`
+- [ ] J'ai ajouté mon nom à la liste des contributeurs du chapitre (ou en tant qu'auteur si pertinent)
+- [ ] J'ai suivi les bonnes pratiques de rédaction (cf. `docs/CONTRIBUTING.md`)
+- [ ] J'ai cité les sources externes utilisées pour la création du chapitre (si pertinent)

.github/workflows/generate_static_site.yaml

@@ -0,0 +1,28 @@
+name: Generate static site
+on:
+  push:
+    branches:
+      - main
+jobs:
+  static:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+      - name: install reveal-md
+        run: npm install -g reveal-md
+      - name: generate static site
+        run: reveal-md ./cours --static --glob '*.slides.md'
+      - name: run the apply_theme bash script
+        run: bash ./apply_theme.sh
+      - name: remove index.html
+        run: rm ./_static/index.html
+      - name: rename 00_index.slides.html to index.html
+        run: mv ./_static/00_index.slides.html ./_static/index.html
+      - name: push to gh-pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          folder: ./_static

.gitignore

@@ -0,0 +1,3 @@
+template_support.iml
+.idea
+_static

CONTRIBUTING.md

@@ -0,0 +1,33 @@
+# Guide de contribution
+
+## Introduction
+
+Ce guide a pour but de vous aider à contribuer à ce dépôt.
+En addition, vous pouvez retrouver la documentation technique et les bonnes pratiques de rédaction dans le répertoire `docs`.
+
+## Ajouter des chapitres 🏷️
+
+[Guide de rédaction](./docs/REDACTION.md)
+
+> Lors de la création d'un chapitre, il est important d'ajouter un exercice associé.
+
+- Créez un fork du dépôt
+- Ajoutez un nouveau fichier dans le répertoire `cours` (veuillez suivre la nomenclature)
+- Ajoutez le chapitre à la table des matières (`index.md`)
+- Ajoutez le ou les exercices associés dans le répertoire `exercices` (veuillez suivre la nomenclature)
+- Créez une pull request
+- Précisez les améliorations apportées dans la description de la PR
+- Associez votre PR à une issue (si elle existe)
+
+## Corriger des chapitres 🐞
+
+- Créez un fork du dépôt
+- Corrigez le chapitre concerné
+- Créez une pull request
+- Précisez les améliorations apportées dans la description de la PR
+- Associez votre PR à une issue (si elle existe)
+
+## Remonter un problème 🐜
+
+Si vous constatez un problème/une erreur dans un chapitre, vous pouvez le remonter en créant une issue.
+Pensez à vérifier si l'issue n'a pas déjà été remontée par vous ou un autre contributeur ou si une PR n'existe pas déjà.

LICENSE

@@ -0,0 +1,34 @@
+Copyright (c) 2023, Octocorn
+All rights reserved.
+
+Octocorn License v1.0
+
+Redistribution and use, with
+or without modification, are permitted provided that the
+following conditions are met:
+
+    1. Redistributions must retain the
+        above copyright notice, this list of conditions and
+        the following disclaimer.
+    2. Neither the name of the Octocorn Organization nor the names
+        of its contributors may be used to endorse or promote
+        products derived from this content without specific
+        prior written permission.
+    3. This content should be used for educational purposes only.
+       In this cas, the Octocorn Organization should be credited
+       as the original author of this content.
+
+THIS COURSE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE. <ORGANIZATION> ACCEPTS NO LIABILITY FOR
+ANY INJURIES OR EXPENSES SUSTAINED IN THE ACT OF FULFILLING ANY OF
+THE ABOVE TERMS AND CONDITIONS, ACCIDENTAL OR OTHERWISE.

README.md

@@ -0,0 +1,28 @@
+# Nom du cours
+
+## Description et objectifs 🎯
+
+<!--- Décrire le cours en quelques lignes -->
+
+## Exercices 💪
+
+Vous retrouverez les exercices dans le dossier `./exercices`.
+
+Pour chaque exercice, vous retrouverez trois niveaux de difficulté : 
+- Coq : Version avancée de l'exercice, avec très peu d'indications
+- Poulet : Version "classique", avec quelques indices
+- Poussin : Version "guidée", avec rappels des notions importantes et indices supplémentaires
+
+> ⚠️ Dans tous les cas, il s'agit bien du même exercice avec plus ou moins d'indications ! ⚠️
+
+## Plan de cours 🗺️
+
+<!--- 
+- [ ] Chapitre
+-->
+
+## Ressources 👜
+
+<!-- 
+- Citez les sources utilisées pour la création du cours
+-->

apply_theme.sh

@@ -0,0 +1,18 @@
+# This script is used for applying the theme to the github pages
+
+for file in $(find _static -name "*.html"); do
+    echo "Adding script to $file"
+    sed -i 's/<\/head>/<script type="text\/javascript">\
+      setTimeout(() => { \
+        fetch("https:\/\/raw.githubusercontent.com\/Alex-Octocorn\/logo\/main\/style.js") \
+          .then(script => script.text())\
+          .then((script) => {\
+            const head = document.querySelector("head");\
+            const customCss = document.createElement("script");\
+            customCss.type = "text\/javascript";\
+            customCss.appendChild(document.createTextNode(script));\
+            head.appendChild(customCss);\
+          });\
+      });\
+    <\/script><\/head>/g' $file
+done

cours/00_index.slides.md

@@ -0,0 +1,12 @@
+---
+title: Template
+theme: solarized
+author: Alexandre Devos
+company: Octocorn
+contributors: 
+  - Alexandre Devos
+---
+
+# Index
+
+- [Intitulé](./cours/nom.md)

cours/99_template.slides.md

@@ -0,0 +1,12 @@
+---
+title: Template
+theme: solarized
+author: Alexandre Devos
+company: Octocorn
+contributors: 
+  - Alexandre Devos
+sources:
+  - 
+---
+
+# Titre

docs/README.md

@@ -0,0 +1,37 @@
+# Documentation technique
+
+## Installation
+
+### Prérequis
+
+- [Node.js](https://nodejs.org/en/)
+
+### Installation des dépendances
+
+Il faut installer `reveal-md` pour pouvoir visualiser les slides en local.
+L'installation doit être faite en global.
+
+```bash
+npm i -g reveal-md
+```
+
+## Utilisation
+
+### Visualisation des slides
+
+Pour visualiser les slides, il faut lancer la commande suivante :
+
+```bash
+reveal-md 00_index.slides.md
+```
+
+### Générer un site statique
+
+```bash
+reveal-md ./ --static --glob '*.slides.md'
+```
+
+### Exporter en PDF
+
+1. Ouvrir les slides dans le navigateur
+2. Ajouter `?print-pdf` à la fin de l'URL : `http://localhost:1948/01_template.slides.md?print-pdf`