Skip to main content

Generate README.md files automatically

Project description

License: MIT Stars

lazyREADME

donate

An intuitive CLI tool to automatically generate professional READMEs for your projects.

🔧 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

  1. Fork the repository

  2. Create a new branch:

    git checkout -b feature-name
    
  3. Commit your changes:

    git commit -m "Add new feature"
    
  4. Push the branch:

    git push origin feature-name
    
  5. Submit a pull request


📋 Commit Guidelines

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation changes

👥 Authors

🛠️ Technologies Used

  • 🐍 Python 3.8+
  • 📦 Main libraries:
    • questionary - For interactive CLI interface
    • colorama - For colored terminal output

📬 For questions or support


🤞🏻 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


💖 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

lazyreadme-1.0.6.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lazyreadme-1.0.6-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

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

Hashes for lazyreadme-1.0.6.tar.gz
Algorithm Hash digest
SHA256 e4660dd63621f52585c53a10c1f4b0921c49a2edcbfdd8754ed1c18174734ebb
MD5 62639000420f7c9a457febed5e28ba93
BLAKE2b-256 b25c174e50296ddf560e8a9d52debc748e1442b2db10c8f91b9bb8b92603089e

See more details on using hashes here.

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

Hashes for lazyreadme-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 00f2da069f36ae47a3d4926076c6fc594c20eea1d3d09e85326c7658f8d64192
MD5 2dc1533e6ddc0852bf210b1d06701bfe
BLAKE2b-256 84a473a4f4736da6b0354c0c23cb706ad8edf91340e1bf86f05fa56118776993

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page