Commit a2ea78da authored by Hugo Trentesaux's avatar Hugo Trentesaux

doc et warnings

refaire la documentation
ajouter des alt pour virer les warnings
parent d12f64f2
- français : [LISEZ-MOI.md](LISEZ-MOI.md)
- english : [READ-ME.md](READ-ME.md)
# README
Site disponible à l'adresse https://duniter.org/fr
## Développer localement
Vous aurez besoin des paquets python3, npm, plantuml graphviz
```bash
sudo apt install python3 npm plantuml graphviz
```
Créez ensuite un evnironnement virtuel python dédié à ce site.
```bash
python3 -m venv env # créer l'environnement "env"
source env/bin/activate # activer l'environnement
pip install -r requirements.txt # installer les dépendances python
```
Compilez le site et servez-le localement
```bash
pelican content
pelican --autoreload --listen
```
## :)
\ No newline at end of file
......@@ -58,6 +58,6 @@ La commande que nous venons d'exécuter a créé un dossier `coverage`, qui cont
Vous pouvez visualiser et étudier la couverture du code est ouvrant le fichier `coverage/index.html` dans votre navigateur :
![]({static}/images/tuto-dev/coverage.png)
![coverage]({static}/images/tuto-dev/coverage.png)
> Passer à la suite du tutoriel : [Chapitre 4. Démarrage]({filename}chapitre-4-demarrage.md).
......@@ -52,11 +52,11 @@ cp -r doc/.vscode .vscode
À partir de là, à l'aide de la combinaison de touches Ctrl+Shift+D, vous pouvez sélectionne la configuration de débogage souhaitée :
![]({static}/images/tuto-dev/debug_selection.png)
![debug_selection]({static}/images/tuto-dev/debug_selection.png)
Vous pouvez sélectionner la configuration `MOCHA ALL TESTS` dans un premier temps, puis appuyer sur la touche `F5`. VSCode devrait alors lancer les tests automatisés de Duniter, ce qui peut durer plusieurs minutes :
![]({static}/images/tuto-dev/debug_tests_done.png)
![debug_tests_done]({static}/images/tuto-dev/debug_tests_done.png)
### Point d'arrêt
......@@ -64,15 +64,15 @@ Vous pouvez sélectionner la configuration `MOCHA ALL TESTS` dans un premier tem
Par exemple, plaçons un point d'arrêt dans le fichier `app/modules/daemon.ts` :
![]({static}/images/tuto-dev/debug_direct_start.png)
![debug_direct_start]({static}/images/tuto-dev/debug_direct_start.png)
Puis lançons le débogage sur `direct_start` :
![]({static}/images/tuto-dev/debug_direct_start_launcher.png)
![debug_direct_start_launcher]({static}/images/tuto-dev/debug_direct_start_launcher.png)
Alors, VSCode lance `node bin/duniter direct_start` en mode debug, et nous permet d'atterir dans le code dont l'exécution est suspendue au point d'arrêt :
![]({static}/images/tuto-dev/debug_point_suspendu.png)
![debug_point_suspendu]({static}/images/tuto-dev/debug_point_suspendu.png)
Nous avons ici une foule d'informations disponibles ! Nous pouvons placer le curseur de la souris sur une variable pour avoir son contenu, nous déplacer dans la pile des appels, ajouter des espions, etc. Ce sont là des informations extrêmement précieuses, notamment quand le code devient plus complexe.
......
......@@ -69,17 +69,17 @@ duniter plug git+https://github.com/duniter/module-example.git
Ou dans l'interface graphique :
![]({static}/images/modules/modules_install.png)
![modules_install]({static}/images/modules/modules_install.png)
Puis cliquez sur « Installer ». A la fin de la procédure, relancez votre nœud.
Vous devriez alors voir dans l'interface graphique un nouveau menu :
![]({static}/images/modules/modules_menu.png)
![modules_menu]({static}/images/modules/modules_menu.png)
Vous pouvez cliquer dessus pour voir le contenu du module :
![]({static}/images/modules/modules_resultat.png)
![modules_resultat]({static}/images/modules/modules_resultat.png)
## Désinstaller un module
......@@ -87,7 +87,6 @@ La désinstallation s'effectue de deux façons :
* avec la ligne de commande (Duniter Server uniquement) :
duniter unplug <nom_du_module>
* avec l'interface graphique : cliquez simplement sur le bouton « On/Off ».
......
aadict==0.2.3
asset==0.6.13
beautifulsoup4==4.9.1
blinker==1.4
cssmin==0.2.0
docutils==0.16
feedgenerator==1.9.1
globre==0.1.5
httplib2==0.18.1
importlib-metadata==1.6.1
Jinja2==2.11.2
lessc==0.1.3
Markdown==3.2.2
MarkupSafe==1.1.1
pelican==4.2.0
pelican-webassets==0.1.0
pelican-youtube==0.2.0
pkg-resources==0.0.0
plantuml==0.3.0
plantuml-markdown==3.2.2
Pygments==2.6.1
python-dateutil==2.8.1
pytz==2020.1
six==1.15.0
soupsieve==2.0.1
Unidecode==1.1.1
webassets==2.0
zipp==3.1.0
Markdown is supported
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