From a53ed90ebf4bcf3ff2f7c7c38eaf9077cfa11c96 Mon Sep 17 00:00:00 2001 From: Djalim Simaila Date: Mon, 25 Mar 2024 12:10:19 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs(README.md):=20improve=20gra?= =?UTF-8?q?mmar,=20spelling,=20and=20formatting=20for=20better=20readabili?= =?UTF-8?q?ty=20and=20understanding?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5649f62..95b5606 100644 --- a/README.md +++ b/README.md @@ -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). \ No newline at end of file + +L'avantage de ce dernier est qu'il affiche les résultats dans le notebook en plus de générer les fichiers. \ No newline at end of file