mdCreator is a Python project. mdCreator can create a README.md file using basic Python functionalities. mdCreator is connected to the Tenor API to get Gifs.
This project is under the jurisdiction of the MIT License. Don't do dumb things.
In order to make mdCreator work from anywhere you can add it inside your $PATH environment variable:
$> export PATH=$PATH:path_to_mdCreator
To use this project, you'll need Python (Version 3.8):
Please refer to this link in order to install requests python 3 module and python-dotenv python 3 module:
mdCreator is a little Python Script dedicated to help programmers to not spend 4 hours creating a README.md. Created README.md is perfectly customisable using a .json configuration file.
mdCreator use Tenor GIF Api. To use mdCreator, you will need a Tenor API Key. To get one, you can check this.
mdCreator works as it follows:
$> mdCreator --pname <Project Name> -l <Project's Main Language>
You can have access to every option, you can use -h / --help option or read the table below.
| Options | Action | Mandatory |
|---|---|---|
| -p / --pname Name | Project Name | ☑ |
| -l / --language Language | Project's Main Language | ☑ |
| -a / --array | Create a table in your README.md | ☐ |
| -g / --gif [Keywords ...] | Add Gifs corresponding to the keywords you give | ☐ |
You can also change the written categories by changing the mdCreator.json configuration file by adding / removing the categories. Please use the following syntax while adding categories:
{
"student": {
"authors": {
"range": 2,
"title": "My new title",
"description": "My new description"
},
}
}
where
range is the size of the title to add to the README (1 is the biggest and 3 is the smallest)For more information about configuration file, please check the mdCreator wiki!
You now have the choice between a student configuration and a new professional configuration. Feel free to edit the 'pro' section inside the mdCreator.json configuration file.
mdCreator is developed with Python. There's not a real coding style, but I tried being the cleaner possible.
- Arthur Adam - 0Nom4D