Initial commit

README.md

@@ -0,0 +1,25 @@
+# Template-project
+
+Template pour la création d'un repo type projet pour le MakerSpace. Doc gérée via le thème [Just-The-Docs](https://just-the-docs.com) en vanilla.
+
+## Bienvenue sur Notre Projet
+
+Ce repository est le cœur de notre projet. Ici, vous trouverez toutes les ressources nécessaires pour comprendre, utiliser et contribuer à notre projet.
+
+### Contenu du Repository
+
+- **Documentation :** Toutes les documentations techniques et guides d'utilisation sont disponibles dans le dossier `docs`. Voir le site de doc associé. 
+- **project :** Toutes les sources de notre projet.
+
+### Comment Utiliser ce Repository ?
+
+- Pour commencer, consultez la documentation dans le dossier `docs`.
+- Si vous souhaitez contribuer au projet, veuillez lire nos directives de contribution.
+
+## Contribution
+
+Nous accueillons et apprécions toute contribution. Si vous souhaitez contribuer, veuillez consulter notre guide de contribution pour connaître nos attentes et notre processus.
+
+## Contact
+
+Si vous avez des questions ou des suggestions, n'hésitez pas à nous contacter.

docs/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gem "jekyll", "~> 4.0"
+gem "jekyll-remote-theme"
+gem 'jekyll-seo-tag'
+gem 'jekyll-include-cache'
+gem 'rake'

docs/Gemfile.lock

@@ -0,0 +1,90 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.2.3)
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    eventmachine (1.2.7)
+    ffi (1.16.3)
+    ffi (1.16.3-x64-mingw-ucrt)
+    forwardable-extended (2.6.0)
+    google-protobuf (3.25.2-x64-mingw-ucrt)
+    google-protobuf (3.25.2-x86_64-linux)
+    http_parser.rb (0.8.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.3.3)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (>= 2.0, < 4.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 2.3, >= 2.3.1)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (>= 0.3.6, < 0.5)
+      pathutil (~> 0.9)
+      rouge (>= 3.0, < 5.0)
+      safe_yaml (~> 1.0)
+      terminal-table (>= 1.8, < 4.0)
+      webrick (~> 1.7)
+    jekyll-include-cache (0.2.1)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-remote-theme (0.4.3)
+      addressable (~> 2.0)
+      jekyll (>= 3.5, < 5.0)
+      jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
+      rubyzip (>= 1.3.0, < 3.0)
+    jekyll-sass-converter (3.0.0)
+      sass-embedded (~> 1.54)
+    jekyll-seo-tag (2.8.0)
+      jekyll (>= 3.8, < 5.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.4)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (5.0.4)
+    rake (13.1.0)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.6)
+    rouge (4.2.0)
+    rubyzip (2.3.2)
+    safe_yaml (1.0.5)
+    sass-embedded (1.63.6-x64-mingw-ucrt)
+      google-protobuf (~> 3.23)
+    sass-embedded (1.63.6-x86_64-linux-gnu)
+      google-protobuf (~> 3.23)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+
+PLATFORMS
+  x64-mingw-ucrt
+  x86_64-linux
+
+DEPENDENCIES
+  jekyll (~> 4.0)
+  jekyll-include-cache
+  jekyll-remote-theme
+  jekyll-seo-tag
+  rake
+
+BUNDLED WITH
+   2.4.19

docs/_config.yml

@@ -0,0 +1,27 @@
+title: Doc Projet
+description: Documentation du projet
+
+# NE RIEN MODIFIER CI-DESSOUS SI VOUS N'ETES PAS CERTAINS DE CE QUE VOUS FAITES
+
+# Thème
+remote_theme: pmarsceill/just-the-docs
+
+# Paramètres optionnels de "Just the Docs"
+just_the_docs:
+  navigation_depth: 5
+  search_enabled: true
+  search_indexing: true
+
+# Plugins
+plugins:
+  - jekyll-remote-theme
+
+# Exclusions
+exclude:
+  - Gemfile
+  - Gemfile.lock
+  - node_modules
+  - vendor/bundle
+  - vendor/cache
+  - vendor/gems
+  - vendor/ruby

docs/conception.md

@@ -0,0 +1,7 @@
+---
+layout: default
+nav_order: 5
+title: Conception et prototypage
+---
+
+# Conception et prototypage

docs/etapes/etape_1.md

@@ -0,0 +1,31 @@
+---
+layout: default
+title: Préparation des Matériaux
+parent: Etapes de fabrication
+nav_order: 1
+---
+
+# Préparation des Matériaux
+
+Cette section décrit la première étape du processus de fabrication : la préparation des matériaux.
+
+## Liste des Matériaux
+
+- Matériau A
+- Matériau B
+- Outils nécessaires
+
+## Procédure de Préparation
+
+1. **Nettoyage** : Nettoyez tous les matériaux pour enlever la poussière et les débris.
+2. **Découpe** : Découpez les matériaux A et B selon les dimensions spécifiées.
+3. **Prétraitement** : Appliquez un traitement de surface si nécessaire.
+
+## Conseils de Sécurité
+
+- Portez toujours l'équipement de protection individuelle.
+- Suivez les instructions de sécurité des outils utilisés.
+
+---
+
+Une fois cette étape terminée, passez à l'[Assemblage](/assemblage).

docs/etapes/etape_2.md

@@ -0,0 +1,25 @@
+---
+layout: default
+title: Assemblage
+parent: Etapes de fabrication
+nav_order: 2
+---
+
+# Assemblage
+
+Après la préparation des matériaux, l'étape suivante est l'assemblage.
+
+## Étapes d'Assemblage
+
+1. **Organisation** : Organisez tous les composants préparés.
+2. **Assemblage Initial** : Commencez par assembler les pièces principales.
+3. **Fixation** : Fixez solidement les pièces ensemble en utilisant les outils appropriés.
+
+## Vérifications à Effectuer
+
+- Assurez-vous que toutes les pièces sont correctement alignées.
+- Vérifiez la stabilité et la solidité de l'assemblage.
+
+## Problèmes Communs et Solutions
+
+- Si des pièces ne s'emboîtent pas correctement, vérifiez leur alignement et leur dimension

docs/etapes/etapes.md

@@ -0,0 +1,27 @@
+---
+layout: default
+title: Etapes de fabrication
+nav_order: 6
+has_children: true
+---
+
+# Étapes de Fabrication
+
+Bienvenue dans la section dédiée aux étapes de fabrication du projet XYZ. Ici, vous trouverez des guides détaillés pour chaque étape du processus de fabrication.
+
+## Aperçu des Étapes
+
+Le processus de fabrication est divisé en plusieurs étapes clés :
+
+1. [Préparation des Matériaux](etape_1)
+2. [Assemblage](etape_2)
+3. [Finition]()
+4. [Contrôle Qualité]()
+
+## Commencer
+
+Pour commencer, assurez-vous de bien comprendre chaque étape et de disposer de tous les outils et matériaux nécessaires. Suivez les étapes dans l'ordre pour garantir la qualité et l'efficacité du processus de fabrication.
+
+---
+
+Pour toute question ou aide supplémentaire, n'hésitez pas à contacter notre équipe.

docs/etudes.md

@@ -0,0 +1,7 @@
+---
+layout: default
+nav_order: 4
+title: Études et choix techniques
+---
+
+# Études et choix techniques

docs/index.md

@@ -0,0 +1,36 @@
+---
+layout: home
+nav_order: 1
+title: Accueil
+---
+
+# Bienvenue sur notre documentation
+
+Bienvenue dans la documentation du projet XYZ. Ce site a pour but de fournir toutes les informations nécessaires pour comprendre, utiliser et reproduire efficacement notre projet.
+
+![Illustration vectorielle colorée avec un fond blanc, montrant un atelier équipé pour un projet de conception mécanique, électronique et informatique](images/illustration.png)
+
+## À propos du Projet
+
+Décrivez ici en quelques lignes l'objectif et l'aperçu général de votre projet. Quel est son but ? À qui est-il destiné ? Quels problèmes cherche-t-il à résoudre ?
+
+## Poster
+
+Ici vous publierez le poster de votre projet.
+
+![Poster projet](images/poster.jpg)
+
+## Vidéo
+
+Ici vous publierez la vidéo de votre projet. 
+- Moins de 1min30
+- Présentation du projet 
+- Des explication du fonctionnement du projet
+- Des vues du projet / Prototype / Application etc... 
+- Des plans du fonctionnement (même basique ou des éléments séparés)
+- Une conclusion
+Si en stockage local : >50mo
+
+<video src="images/intro_amiens.mp4" controls title="Title"  style="width: 100%;"></video>
+
+---

docs/objectifs.md

@@ -0,0 +1,25 @@
+---
+layout: default
+nav_order: 3
+title: Objectifs du projet
+---
+
+# Introduction
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed non risus. Suspendisse lectus tortor, dignissim sit amet, adipiscing nec, ultricies sed, dolor.
+
+## Contexte du Projet
+
+Cras elementum ultrices diam. Maecenas ligula massa, varius a, semper congue, euismod non, mi. Proin porttitor, orci nec nonummy molestie, enim est eleifend mi, non fermentum diam nisl sit amet erat.
+
+## Objectifs du Projet
+
+Duis semper. Duis arcu massa, scelerisque vitae, consequat in, pretium a, enim. Pellentesque congue. Ut in risus volutpat libero pharetra tempor. Cras vestibulum bibendum augue. Praesent egestas leo in pede.
+
+# Existant
+
+Praesent blandit adipiscing velit. Suspendisse potenti. Donec mattis, pede vel pharetra blandit, magna ligula faucibus eros, id euismod lacus dolor eget odio.
+
+# Cahier des Charges
+
+Nam dui ligula, fringilla a, euismod sodales, sollicitudin vel, wisi. Morbi auctor lorem non justo. Nam lacus libero, pretium at, lobortis vitae, ultricies et, tellus.

docs/premiers-pas/introduction_git_github.md

@@ -0,0 +1,45 @@
+---
+layout: default
+title: Introduction à GitHub et Git
+parent: Premiers pas sur le template
+nav_order: 1
+---
+
+
+# Introduction Basique à GitHub, GitHub Desktop et VSCode
+
+Ce document fournit une introduction simple à l'utilisation de GitHub pour la gestion de version, ainsi qu'une présentation de GitHub Desktop et de l'intégration avec Visual Studio Code (VSCode).
+
+## GitHub : Gestion de Version Simplifiée
+
+GitHub est une plateforme en ligne qui permet de stocker, partager et collaborer sur des projets de code. Il utilise Git, un système de contrôle de version, pour suivre les changements dans les fichiers au fil du temps.
+
+### Pourquoi utiliser GitHub ?
+
+- **Collaboration :** Facilite la collaboration sur des projets, permettant à plusieurs personnes de travailler ensemble.
+- **Historique des modifications :** Chaque modification est enregistrée, permettant de revenir à des versions antérieures si nécessaire.
+- **Facilité d'accès :** Accédez à vos projets de n'importe où et partagez-les facilement avec d'autres.
+
+## [GitHub Desktop](https://desktop.github.com) : Gestion de Version sans Commandes
+
+[GitHub Desktop](https://desktop.github.com) est une application qui simplifie l'utilisation de Git et GitHub sans avoir besoin d'utiliser la ligne de commande.
+
+### Fonctionnalités Clés
+
+- **Interface utilisateur intuitive :** Facile à utiliser pour les débutants.
+- **Gestion de repositories :** Cloner, créer et publier des repositories directement depuis l'application.
+- **Commit et Push :** Facilite la réalisation de commits et l'envoi de vos modifications sur GitHub.
+
+## [Visual Studio Code (VSCode)](https://code.visualstudio.com) : Éditeur de Code et Intégration Git
+
+[VSCode](https://code.visualstudio.com) est un éditeur de code source qui intègre des fonctionnalités Git, facilitant la modification de fichiers et la gestion de version.
+
+### Avantages de l'Utilisation de VSCode
+
+- **Éditeur de Code Puissant :** Supporte de nombreux langages de programmation et possède de nombreuses extensions.
+- **Intégration Git :** Permet de réaliser des opérations Git de base directement depuis l'éditeur.
+- **Prévisualisation de Markdown :** Utile pour éditer des fichiers README et d'autres documents en Markdown.
+
+## Conclusion
+
+L'utilisation de GitHub avec GitHub Desktop et VSCode offre une expérience complète pour la gestion de projets de code. Cette combinaison est particulièrement utile pour ceux qui préfèrent une approche visuelle et intuitive de la gestion de version.