ajamous / github-readme-evaluator

The GitHub README Evaluator is a web-based tool designed to evaluate the effectiveness of a GitHub README file. The tool scans a README for essential sections, checks its length, and evaluates its readability, providing actionable feedback to improve your documentation.

GitHub README Evaluator

Description

The GitHub README Evaluator is a web-based tool powered by OpenAI's GPT-3, designed to evaluate and improve the effectiveness of a GitHub README file. The tool scans a README for essential sections, checks its length, evaluates its readability, and leverages natural language processing to provide actionable feedback and suggestions for improvement.

🚀 Features

• Evaluates essential README sections like "Getting Started", "Usage", "Installation", etc.
• Provides readability scores based on the Flesch Reading Ease test.
• Easy-to-understand feedback with suggestions for improvement.
• New: Uses OpenAI's GPT-3 for Natural Language Processing tasks including:
  • Quality evaluation of the README text
  • Summarization of README content
  • Topic Modeling to identify main themes
  • Personalized recommendations for README improvements

📚 Table of Contents

• Features
• Installation
• Usage
• Contribution
• License

🛠 Installation

1. Clone the repository

   git clone https://github.com/ajamous/github-readme-evaluator.git
   

2. Navigate to the project directory

   cd github-readme-evaluator
   

3. Install dependencies

   pip install -r requirements.txt
   

4. Run the Flask application

   flask run
   

🎯 Usage

Screen.Recording.2023-10-29.at.6.56.39.PM.mov

1. Open your browser and go to http://127.0.0.1:5000/
2. Enter a GitHub repository URL in this format github_username/repo_name
3. Click "Evaluate" to get results

👨‍💻 Contribution

1. Fork the project
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new pull request

📝 License

MIT License. See LICENSE for more information.