Guide d'utilisation - fabienvorpe/MDToHTML GitHub Wiki

Ce document est le guide d'utilisation du projet MDToHTML, réalisé par Chacun Guillaume, Graells Noah & Vorpe Fabien.

Requirements

Pour utiliser notre compilateur, il est nécessaire de posséder une version de Python, accompagné des packages suivants :

• PLY
• Pydot-ng

Comment installer

Installation de PLY :

• Sous Linux : apt-get install python-ply
• Sous Windows : Récupérer la dernière version de PLY sur http://www.dabeaz.com/ply/. Décompresser le fichier, se rendre dans le dossier concerné puis installer le package : C:\...\ply-x.y> python setup.py install

Installation de pydot-ng : pip install pydot-ng

Installation de notre programme : Il suffit de décompresser le fichier zip.

Comment utiliser

Il faut premièrement vérifier qu'il existe à la racine du programme : les fichiers de code, un dossier generated (contenant un dossier img) et un dossier resources (il s'agit d'un dossier où placer les images que vous souhaitez utiliser).

Il vous faut ensuite créer un fichier texte qui contiendra le code que vous voulez compiler en HTML.

Il ne vous reste plus qu'à lancer une commande python pour exécuter le fichier parser.py, en lui passant en paramètre le chemin d'un fichier texte : python parser.py <chemin_de_fichier_text>.

Le fichier HTML généré est lancé automatiquement dans votre navigateur et sauvegardé dans le dossier generated.