📝 docs(README.md): improve grammar, spelling, and formatting for better readability and understanding

This commit is contained in:
Djalim Simaila 2024-03-25 12:10:19 +01:00
parent db4f9505da
commit a53ed90ebf

View File

@ -1,12 +1,15 @@
## TLDR
## TL;DR
Le module Python Mocodo est un wrapper pour le programme Mocodo. Il peut être utilisé pour faciliter des scripts. On utilise donc le module :
Le module python mocodo est un wrapper pour le programe mocodo, il peut etre utilusé pour faciliter des scipts
on utilise donc le module
```python
from mocodo.api import mocodo
```
ou etre utilisé dans un notebook, dans ce cas on utilse
``` python
ou être utilisé dans un notebook. Dans ce cas, on utilise :
```python
from mocodo.magic import mocodo
```
L'avantage de ce dernier est qu'il affiche les resultats dans le notebook (en plus de gerener les fichiers).
L'avantage de ce dernier est qu'il affiche les résultats dans le notebook en plus de générer les fichiers.