A command-line tool to quickly generate README.md files.
Clone the repository and install locally:
git clone https://github.com/LuisAbrantes/quickreadme.git
cd quickreadme
pip install -e .
After installing, navigate to your project directory and run:
quickreadme
Follow the interactive prompts to input your project’s details. Once completed, a README.md file will be generated in your current directory with the information provided.
Contributions are welcome! If you have ideas for improvements or new features, feel free to open an issue or submit a pull request.
1. Fork the project
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a pull request
Please make sure to update tests as appropriate.
If you find this project useful, please consider starring the repository on GitHub. Your support is greatly appreciated and helps increase the visibility of the project!