Skip to content

Files

Latest commit

 

History

History
18 lines (12 loc) · 959 Bytes

README.md

File metadata and controls

18 lines (12 loc) · 959 Bytes

Readme Generator

This a simple Python script which helps with the creation of README.md files for software projects. It prompts users to input project details such as the project name, author name, description, additional features, and credits. Users can choose between three types of README formats:

  • Simple : Provides a basic structure with project overview and table of contents.
  • Detailed : Includes detailed sections on features and credits, in addition to project overview.
  • Documentation : Offers comprehensive documentation structure including installation instructions, usage examples, technology stack, and credits.

Requirements

  • To run the script, you'll need to have Python installed on your system. You can download it from here.

Install

  • Download, clone, or fork this repository.
  • Open your terminal & navigate to the project folder
  • Run the script using the command python3 main.py