About This Tool
ReadMeMaker is a CLI tool that will help users write their README.MD documentation depending on the input files the user specifies.
How to Start Using ReadMeMaker?
Clone the Repository
git clone https://github.com/jadorotan/readMeMaker
Install the Required Dependencies for the tool to work
pip install -r requirements.txt
Create a .env file and put inside your Groq API Key (https://console.groq.com)
GROQ_API_KEY=YOUR API KEY HERE
Basic CLI Usage
This tool is still in it's early stages and doesn't have much any complex commands. One such example of a simple command you can run is this:
python readMeMaker.py -i .\examples\simpleCalculator.py -o .\examples\generated.md
The command above will take the input file simpleCalculator.py that's inside the examples directory and using the -o option will store the generated.md file inside the same directory as the calculator python file. A demo of several other commands can also be found in this video: Youtube Demo.
Other CLI OPTIONS
| Option | Shortcut | Description | Default |
|---|---|---|---|
| -v | --version | Show the version of the tool. | - |
| -h | --help | Show this help message and exit | - |
| -i | --input | The input files for which to generate a README.md. | - |
| -o | --output | Specify the output file name and file path. | Creates a README.md file in the same directory |
| -m | --model | Specify the model to use for generating the README.md. | Uses llama3-8b-8192 |
GitHub Repository
If you are interested in using this tool or even trying to contribute and improve the tool further, you can find it at: readMeMaker.
Conclusion
ReadMeMaker is still in its early stages of development but even so, this tool with its simple options can aid its users with writing their README.MD documentation for their code and possibly streamlining the process and saving time for the users who aren't well-versed in writing their own markdown files. This tool was made by utilizing Groq's AI Chat Completions Prompts.
Top comments (4)
This tool makes a lot of sense because it solves a commonly perceived problem, namely that developers would rather write code than write documentation. This perceived problem is shared by Steven Vaughan-Nichols in his post entitled Linux and open-source documentation is a mess: Here's the solution.
readMeMaker has the potential to write a great first draft for the
README.mdfile that necessarily documents an open source project.Let's make
README.mdgreat again!Nice project! I just read all the code and watched the video, and I can confirm it is looking great, I do have some suggestion for improvement if you want to hear let me know and I will write them down here
Yes @burgil, if you have any suggestions for improving this project I would like to hear more about it. Also, thank you for taking the time to look through my project and for your kind words!
Nice project ! 💯☺️!! This would make the life more easier for devs who have just started github.
Some comments may only be visible to logged-in visitors. Sign in to view all comments.