Commit f5e93a77 authored by Jonathan Wiedemann's avatar Jonathan Wiedemann
Browse files

Update Readme and move icons in the right folder.

parent 04c887d7
# MOOC-Workbench
# MOOC-Workbench ![mooc-wb](/medias/images/mooc-workbench.png)
Il ne s'agit pas d'un tuto sur FreeCAD, mais d'un cours sur la modélisation 3D. FreeCAD n'est
ici qu'un outil support du propos. L'intérêt porté par l'apprenant pour le sujet ou l'amusement
qu'il procure, doit être le moteur de découverte de FreeCAD.
# Sommaire
* [Utilisation](https://framagit.org/freecad-france/mooc-workbench#utilisation)
* [Installation](https://framagit.org/freecad-france/mooc-workbench#installation)
Cet atelier FreeCAD vous suivra tous le long de ce mooc pour vous guider dans l'apprentissage de la modélisation 3D avec FreeCAD. Il permet d'afficher les tutoriels interactif et d'évaluer votre travail.
# Utilisation
## Sommaire
* ### [Installation](https://framagit.org/freecad-france/mooc-workbench#installation)
* ### [Utilisation](https://framagit.org/freecad-france/mooc-workbench#utilisation)
L'atelier est disponible depuis le sélecteur d'atelier ![mooc-wb](/medias/images/mooc-workbench.png)
## Installation
### Installation avec l'addon manager
/!\ Pas encore disponible /!\
### Installation manuelle
1. Télécharger l'archive zip à cette adresse : [Mooc-Workbench.zip](https://framagit.org/freecad-france/mooc-workbench/-/archive/master/mooc-workbench-master.zip)
2. Extraire l'archive dans le dossier Mod de FreeCAD
L'emplacement du dossier Mod de FreeCAD dépend de votre système d'exploitation :
* Windows : habituellement C:\Users\username\AppData\Roaming\FreeCAD\Mod
* Mac : habituellement /Users/username/Library/Preferences/FreeCAD/Mod
* Linux : habituellement /home/username/.FreeCAD/Mod
Si le dossier mod n'existe pas, créer le.
3. (Re)Lancer FreeCAD
## Utilisation
L'atelier est disponible depuis le menu Affichage puis Atelier ou depuis le sélecteur d'atelier :
<img src="/medias/images/MenuSelectWB.png" width=45% > <img src="/medias/images/ToolSelectWB.png" width=45% >
L'atelier MOOC propose 2 outils :
* ![mooc-wb](/medias/images/mooc-player.png) MOOC Player qui permet de lancer les tutoriels interactifs.
* ![mooc-wb](/medias/images/mooc-grader.png) MOOC Grader qui permet de faire une évaluation d'un exercice.
* ![mooc-wb](/medias/images/mooc-grader.png) MOOC Grader qui permet de faire une évaluation d'un exercice.
### MOOC Player
Accessible depuis le menu **MOOC** puis **Choisir la leçon**.
Les tutoriaux interactif sont accessible en cliquant sur le bouton Play, juste ici.
Une fenêtre s'ouvre et permet de choisir quel tutoriels voir.
Sélectionner un élément de la liste puis cliquer sur OK pour éxecuter la leçon.
Une fenêtre s'ouvre avec une liste des tutoriel disponible :
Une nouvelle fenêtre s'ouvre et permet de suivre le tutoriel étape par étape.
Le résumé de la leçon explique comment atteindre les objectifs de l'étape en cours.
Le bouton **Voir la vidéo** joue la vidéo de l'étape en cours dans votre navigateur internet.
Le bouton **Aide** vous affichera les liens vers la documentation des outils à utiliser. (#TODO)
<img src="/medias/images/ListeTuto.png" width=45% >
Les objetifs à réaliser bascule de rouge à vert lorsque l'objectif est atteint.
L'idée c'est d'avoir tous les objectifs au vert pour passer à l'étape suivante.
En faisant un simple clic sur un élément de la liste nous obtenons la description en dessous.
Les boutons précédent vous permette de changer d'étapes, entre les deux boutons vous pouvez voir à quelle étape vous êtes et combien il y en a au total.
### MOOC Grader
Pour valider le tutoriel à suivre faites un double clic ou cliquer sur le bouton OK.
Accessible depuis le menu **MOOC** puis **Évaluation de l'exercice**.
Une nouvelle fenêtre s'ouvre et c'est le tutoriel qui commence.
Lorsque vous avez terminer un exercice, vous allez pouvoir l'évaluer à l'aide du MOOC Grader.
<img src="/medias/images/PlayerWindow.png" width=45% >
Choisir l'éxercice dans la premiere liste.
Le premier panneaux vous donne les consignes à suivre pour l'étape en cours.
Choisir le document FreeCAD à évaluer.
Le bouton Vidéo ouvre une vidéo dans votre navigateur web par défaut.
Cliquer sur le bouton **Lancer l'évaluation**.
Le bouton aide vous proposera les liens vers la documentation de chaque outils utilisé dans l'étape en cours.
Dans le panneau de gauche vous verrez les différent critère d'évaluation listé. Si vert alors c'est ok si c'esst rouge c'est faux.
Ensuite il y a la liste des objectifs qui s'affiche en rouge tant que l'objectif n'est pas remplie.
Quand l'évaluation vous satisfait vous pouvez transmettre les résultats en cliquant sur le bouton **Envoyer les résultats**
L'objectif passe au vert dès que qu'il est atteint.
Par exemple à cette étape la première chose à faire est de créer un nouveau document, dès que c'est fait, comme ceci, la ligne passe en vert.
Une fenêtre s'ouvre avec une chaine de caratère qu'il faut copier/coller dans votre espace MOOC. Vous pouvez cliquer sur le bouton **Copier** pour copier la chaine de caractère dans le presse papier. Il vous restera juste à le coller (clic droit coller ou avec le raccouris Ctrl+V).
Enfin vous avez des boutons pour passer à l'étape suivante ou pour revenir. Vous n'avez pas besoin de remplir tous les objectifs pour passer à l'étape suivante.
![FC1](/medias/images/screenshot_mooc_chooser.png)
![FC2](medias/images/screenshot_mooc_player.png)
![FC3](medias/images/screenshot_grader.png)
Lorsque vous avez atteint la fin du tutoriel vous pouvez fermer la fenêtre en cliquant sur la croix de fermeture.
# Installation
### MOOC Grader
## Installation avec l'addon manager
Lorsque vous avez terminer un exercice, vous allez pouvoir l'évaluer à l'aide du MOOC Grader.
/!\ Pas encore disponible /!\
Accessible depuis le menu **MOOC** puis **Évaluer un exercice**.
## Installation manuelle
<img src="/medias/images/FreeCADGraderWindow.png" width=45% >
### 1 Télécharger l'archive zip à cette adresse : [Mooc-Workbench.zip](https://framagit.org/freecad-france/mooc-workbench/-/archive/master/mooc-workbench-master.zip)
Choisir l'éxercice dans la premiere liste.
### 2. Extraire l'archive dans le dossier Mod de FreeCAD
L'emplacement du dossier Mod de FreeCAD dépend de votre système d'exploitation :
Choisir le document FreeCAD à évaluer.
* Windows : habituellement C:\Users\username\AppData\Roaming\FreeCAD\Mod
Cliquer sur le bouton **Lancer l'évaluation**.
* Mac : habituellement /Users/username/Library/Preferences/FreeCAD/Mod
Dans le panneau de gauche vous verrez les différent critère d'évaluation listé. Si vert alors c'est ok si c'esst rouge c'est faux.
* Linux : habituellement /home/username/.FreeCAD/Mod
Quand l'évaluation vous satisfait vous pouvez transmettre les résultats en cliquant sur le bouton **Envoyer les résultats**
Si le dossier mod n'existe pas, créer le.
<img src="/medias/images/EnvoieResult.png" width=45% >
### 3. (Re)Lancer FreeCAD
Une fenêtre s'ouvre avec une chaine de caratère qu'il faut copier/coller dans votre espace MOOC. Vous pouvez cliquer sur le bouton **Copier** pour copier la chaine de caractère dans le presse papier. Il vous restera juste à le coller (clic droit coller ou avec le raccouris Ctrl+V).
......@@ -62,11 +62,12 @@ def MakeDataTutorial():
moocWBpath = os.path.dirname(moocwb_locator.__file__)
moocWBpath_medias = os.path.join(moocWBpath, 'medias')
moocWB_images_path = os.path.join(moocWBpath_medias, 'images')
moocWB_icons_path = os.path.join(moocWBpath_medias, 'icons')
step = {}
img1 = os.path.join(moocWB_images_path, 'Document-new.svg')
img2 = os.path.join(moocWB_images_path, 'Workbench_PartDesign.svg')
img3 = os.path.join(moocWB_images_path, 'PartDesign_Body.png')
img1 = os.path.join(moocWB_icons_path, 'Document-new.svg')
img2 = os.path.join(moocWB_icons_path, 'Workbench_PartDesign.svg')
img3 = os.path.join(moocWB_icons_path, 'PartDesign_Body.png')
img4 = os.path.join(moocWB_images_path, 'korrigans_final.png')
step["description"] = u'''<h3>Préparation</h3> \
<p><img src= %s width="25"/> Créer un nouveau document : \
......@@ -86,7 +87,7 @@ def MakeDataTutorial():
#step2
step = {}
img1 = os.path.join(moocWB_images_path, 'Sketcher_NewSketch.svg')
img1 = os.path.join(moocWB_icons_path, 'Sketcher_NewSketch.svg')
step["description"] = u'''<h3>Esquisse</h3> \
<p>Pour créer la base de l'objet, on va d'abord créer une esquisse \
sur le plan XZ du corps de pièce.</p> \
......@@ -104,10 +105,10 @@ def MakeDataTutorial():
#step3
step = {}
img1 = os.path.join(moocWB_images_path, 'Constraint_Horizontal.svg')
img2 = os.path.join(moocWB_images_path, 'Constraint_Vertical.svg')
img3 = os.path.join(moocWB_images_path, 'Constraint_PointOnPoint.svg')
img4 = os.path.join(moocWB_images_path, 'Sketcher_CreatePolyline.svg')
img1 = os.path.join(moocWB_icons_path, 'Constraint_Horizontal.svg')
img2 = os.path.join(moocWB_icons_path, 'Constraint_Vertical.svg')
img3 = os.path.join(moocWB_icons_path, 'Constraint_PointOnPoint.svg')
img4 = os.path.join(moocWB_icons_path, 'Sketcher_CreatePolyline.svg')
step["description"] = u'''<h3>Géométries et contraintes</h3> \
<p>Dessiner un contour fermé de 5 coté à l'aide de l'outil polyligne.<p> \
<p><img src=%s width="25"/> L'outil polyligne ajoute \
......@@ -124,7 +125,7 @@ def MakeDataTutorial():
#step4
step = {}
img1 = os.path.join(moocWB_images_path, 'Constraint_EqualLength.svg')
img1 = os.path.join(moocWB_icons_path, 'Constraint_EqualLength.svg')
step["description"] = u'''<h3>Contrainte d'égalité</h3> \
<p>Nous pouvons contraindre 2 segments à être égaux, dans notre cas \
on veut que les 2 segments verticaux soient égaux entre eux et de \
......@@ -138,9 +139,9 @@ def MakeDataTutorial():
#step5
step = {}
img1 = os.path.join(moocWB_images_path, 'Constraint_HorizontalDistance.svg')
img2 = os.path.join(moocWB_images_path, 'Constraint_VerticalDistance.svg')
img3 = os.path.join(moocWB_images_path, 'Constraint_InternalAngle.svg')
img1 = os.path.join(moocWB_icons_path, 'Constraint_HorizontalDistance.svg')
img2 = os.path.join(moocWB_icons_path, 'Constraint_VerticalDistance.svg')
img3 = os.path.join(moocWB_icons_path, 'Constraint_InternalAngle.svg')
step["description"] = u'''<h3>Dimensions</h3> \
<p>Pour paramétrer précisement les mesures de notre esquisse, \
on va ajouter des contraintes de dimensions.</p> \
......@@ -166,7 +167,7 @@ def MakeDataTutorial():
#step6
step = {}
img1 = os.path.join(moocWB_images_path, 'Constraint_Symmetric.svg')
img1 = os.path.join(moocWB_icons_path, 'Constraint_Symmetric.svg')
step["description"] = u'''<h3>Contrainte de symétrie</h3> \
<p>Il nous reste 2 degrès de libertés qui sont les positions X et Y \
de notre contour dans l'esquisse.<p> \
......@@ -181,7 +182,7 @@ def MakeDataTutorial():
#step7
step = {}
img1 = os.path.join(moocWB_images_path, 'PartDesign_Pad.svg')
img1 = os.path.join(moocWB_icons_path, 'PartDesign_Pad.svg')
step["description"] = u'''<h3>Faire une protrusion</h3> \
<p>Nous allons maintenant créer une protrusion de 55 mm à partir de \
cette esquisse afin de générer du volume.<p> \
......@@ -199,7 +200,7 @@ def MakeDataTutorial():
#step8
step = {}
img1 = os.path.join(moocWB_images_path, 'Sketcher_External.svg')
img1 = os.path.join(moocWB_icons_path, 'Sketcher_External.svg')
step["description"] = u'''<h3>Arêtes externe</h3> \
<p>Dans cette étape nous allons créer une nouvelle esquisse sur le plan YZ \
pour dessiner un triangle qui nous permettra d'enlever de la matière \
......@@ -216,7 +217,7 @@ def MakeDataTutorial():
#step9
step = {}
img1 = os.path.join(moocWB_images_path, 'PartDesign_Pocket.svg')
img1 = os.path.join(moocWB_icons_path, 'PartDesign_Pocket.svg')
step["description"] = u'''<h3>Faire une cavité</h3> \
<p>Une cavité (pocket en anglais) est une fonction qui sert à enlever de la matière.</p> \
<p>On commence par sélectionner l'esquisse qui servira de base à la \
......@@ -232,7 +233,7 @@ def MakeDataTutorial():
#step10
step = {}
img1 = os.path.join(moocWB_images_path, 'PartDesign_Mirrored.svg')
img1 = os.path.join(moocWB_icons_path, 'PartDesign_Mirrored.svg')
step["description"] = u'''<h3>Répétition</h3> \
<p>Nous n'avons fais qu'un coté du chapeau. On pourrait répéter \
l'opération (esquisse + cavité), on aurait pus dessiner une esquisse \
......@@ -250,7 +251,7 @@ def MakeDataTutorial():
#step11
step = {}
img1 = os.path.join(moocWB_images_path, 'Sketcher_CreateSlot.svg')
img1 = os.path.join(moocWB_icons_path, 'Sketcher_CreateSlot.svg')
step["description"] = u'''<h3>Contour oblong</h3> \
<p>Esquisse avec un contour fermé formant un trou oblong.<p>'''
......@@ -270,7 +271,7 @@ def MakeDataTutorial():
#step13
step = {}
img1 = os.path.join(moocWB_images_path, 'PartDesign_PolarPattern.svg')
img1 = os.path.join(moocWB_icons_path, 'PartDesign_PolarPattern.svg')
step["description"] = u'''<h3>Répétition circulaire</h3> \
<p>On va répéter la cavité 4 fois autour du centre pour obtenir les 4 jambes.<p>'''
......@@ -300,7 +301,7 @@ def MakeDataTutorial():
#step16
step = {}
img1 = os.path.join(moocWB_images_path, 'PartDesign_Plane.svg')
img1 = os.path.join(moocWB_icons_path, 'PartDesign_Plane.svg')
step["description"] = u'''<h3>Créer un plan de référence</h3> \
<p>Nous avons besoin d'un plan de travail décalé par rapport \
au plan YZ pour y appliquer une nouvelle esquisse.<p>
......@@ -339,7 +340,7 @@ def MakeDataTutorial():
#step19
step = {}
img1 = os.path.join(moocWB_images_path, 'Document-save.svg')
img1 = os.path.join(moocWB_icons_path, 'Document-save.svg')
img2 = os.path.join(moocWB_images_path, 'freecadSaveDetail.png')
step["description"] = u'''<h3>Sauvegarder le document.</h3> \
<p><img src=%s width="25"/> Sauvegader le document sous le nom <b>Korrigans</b> : \
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment