Markdown Generator - Generating Server Documentation

Based on markdown-readme-generator project by Pedro Marinho (GitHub : @pedroermarinho)

Remastered by Florian GIGOT (Github : @florianG37).

Copyright © 2020 Florian GIGOT.

This project is MIT licensed.

Notice utilisateur

Installation

• Installez python 3
• Téléchargez generator.zip
• Lancez setup.bat

Utilisation

• Lancez generateJSON.bat pour générer le JSON associé au template
• Remplissez le readme.json
• Lancez generateMD.bat
• Le résultat est écrit dans le fichier README.md

Modification du template

• Model/readme.py : Déclaration des variables
• templates/default.pmd : Déclaration du template
• infos.py : modifier le json généré par défaut