Python README.md Generator

Description

A small Command Line Interface to easily generate a README file with Markdown formatting. Made in Python, with the InquirerPy and Rich libraries.

Installation

• Clone the repository: git clone https://github.com/LynaSim/Python_README_Generator.git

• Set up a virtual environment: python -m venv venv

• Activate the virtual environment:

  • Window: .\venv\Scripts\activate
  • macOS/Linux: source venv/bin/activate

• Install the required dependencies: pip install -r requirements.txt

Usage

• Run main.py
• All prompts require user input and cannot be skipped
• Input validation will stop null or empty string submission
• Multiline input is enabled when appropriate
• Your README.md will be saved in your working directory

License Type

GNU General Public License family

Author

Lyna Sim

Contact

s.lyna.dev@gmail.com