Generate README.md files automatically
Project description
🔧 Prerequisites
- Python 3.8 or higher
- pip (Python package manager)
⚙️ Installation
# Install the package
pip install lazyreadme
🎉 Ready to start!
💡 Running the Project
Navigate to your folder and run:
lazyreadme
✨ Usage Examples
# Navigate to your folder
cd my-project
# Run lazyreadme
lazyreadme
🌟 Key Features
- Automatic generation of professional READMEs
- User-friendly CLI interface
- Easy content customization
🔄 Contribution Process
-
Fork the repository
-
Create a new branch:
git checkout -b feature-name
-
Commit your changes:
git commit -m "Add new feature"
-
Push the branch:
git push origin feature-name
-
Submit a pull request
📋 Commit Guidelines
feat: New featurefix: Bug fixdocs: Documentation changes
👥 Authors
🛠️ Technologies Used
- 🐍 Python 3.8+
- 📦 Main libraries:
- questionary - For interactive CLI interface
- colorama - For colored terminal output
📬 For questions or support
-
📨 Email: raphaeleliass@outlook.com
-
📊 GitHub Issues: Issues Page
🤞🏻 Support the Project
If you like this project and want to contribute to its continuous development, consider making a donation:
🇧🇷 PIX (Brazilian Payment Method)
- PIX Key:
- Name: Raphael Elias
- Bank: Nu Payments
💳 PayPal
- PayPal Link: Donate
💖 Your contribution helps keep this project alive and constantly evolving!
This project is licensed under the MIT License. See the LICENSE file for more details.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file lazyreadme-1.0.6.tar.gz.
File metadata
- Download URL: lazyreadme-1.0.6.tar.gz
- Upload date:
- Size: 8.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e4660dd63621f52585c53a10c1f4b0921c49a2edcbfdd8754ed1c18174734ebb
|
|
| MD5 |
62639000420f7c9a457febed5e28ba93
|
|
| BLAKE2b-256 |
b25c174e50296ddf560e8a9d52debc748e1442b2db10c8f91b9bb8b92603089e
|
File details
Details for the file lazyreadme-1.0.6-py3-none-any.whl.
File metadata
- Download URL: lazyreadme-1.0.6-py3-none-any.whl
- Upload date:
- Size: 8.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
00f2da069f36ae47a3d4926076c6fc594c20eea1d3d09e85326c7658f8d64192
|
|
| MD5 |
2dc1533e6ddc0852bf210b1d06701bfe
|
|
| BLAKE2b-256 |
84a473a4f4736da6b0354c0c23cb706ad8edf91340e1bf86f05fa56118776993
|