jaivardhan-bhola/readme-generator

A GUI tool To Generate Readme.md Files For Projects

Readme Generator

Table of Contents

• Description
• Installation
• Usage
• Screenshots
• About the author
• Contribution
• Support Us
• License

Description

A GUI tool To Generate Readme.md Files For Projects

Installation

• Run

pip install -r requirements.txt

• Create a socials.json file with the following format

{
  "name": "Your Name",
  "email": "your_email@example.com",
  "github": "your_github_username",
  "linkedin": "your_linkedin_profile_url",
  "instagram": "your_instagram_username"
}

Usage

• Run

python main.py

Screenshots

About-the-author

Contribution

If you would like to contribute to this project reach out to me. Contact Information can be found below or by clicking on the 'Contact-Information' link provided in the Table of Contents.

Show-your-support

Give a ⭐️ star if this project helped you!

License

Copyright © 2024 Jaivardhan Bhola.
This project is MIT licensed.

---