Skip to content

README.md

Latest commit

 

History

History
102 lines (69 loc) · 1.33 KB

README.md

File metadata and controls

102 lines (69 loc) · 1.33 KB
Raw

README Generator CLI

A simple and powerful command-line tool to generate professional README.md files for your projects in seconds.

Features

  • Interactive CLI prompts
  • Generates clean and structured README files
  • Includes sections like Description, Installation, Usage, License, etc.
  • Beginner-friendly and lightweight
  • Works on Windows, macOS, and Linux

Installation

pip install auto-readme-jagriti==0.1.0

Usage

Run the following command in your project directory:

readmegen

Then answer the prompts:

Project Name:
Description:
Installation command:
Usage command:
Project structure:
Contribution guidelines:
License:

Example Output

# My Project

##  Description
This is a sample project.

##  Installation
pip install myproject

##  Usage
python main.py

##  Contributing
Pull requests are welcome.

##  License
MIT

Project Structure

readmegen/
│
├── readmegen/
│   ├── __init__.py
│   ├── main.py
│   └── generator.py
│
├── pyproject.toml
├── README.md
└── LICENSE

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

License

This project is licensed under the MIT License.

Author

Developed by Jagriti Srivastava