mirror of
https://github.com/OpenBMB/ChatDev.git
synced 2026-10-11 13:16:53 +00:00
55 lines
1.8 KiB
Markdown
55 lines
1.8 KiB
Markdown
# FAIR_ENOUGH
|
|
|
|
FAIR_ENOUGH is a Python program designed to evaluate a project based on its README.md file and assign a score out of 10 points. This program aims to promote the importance of comprehensive and clear project documentation, helping developers and contributors understand the project easily.
|
|
|
|
## Features
|
|
|
|
- **Readability**: Evaluates the readability of the README.md file.
|
|
- **Completeness**: Checks if all the essential sections are present.
|
|
- **Clarity**: Assesses the clarity of the information provided in the README.md file.
|
|
- **Formatting**: Evaluates the formatting and organization of the content.
|
|
- **Relevance**: Checks if the content is relevant to the project.
|
|
|
|
## Installation
|
|
|
|
To use FAIR_ENOUGH, follow these steps:
|
|
|
|
1. Clone the repository:
|
|
```
|
|
git clone https://github.com/your-username/FAIR_ENOUGH.git
|
|
```
|
|
2. Change into the project directory:
|
|
```
|
|
cd FAIR_ENOUGH
|
|
```
|
|
3. Install the dependencies:
|
|
```
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
## Usage
|
|
|
|
After installation, you can run FAIR_ENOUGH by following these steps:
|
|
|
|
1. Run the program:
|
|
```
|
|
python fair_enough.py <path-to-readme-file>
|
|
```
|
|
Replace `<path-to-readme-file>` with the path to the README.md file you want to evaluate.
|
|
|
|
2. The program will output the score of the README.md file along with a report on each evaluation criteria.
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome! If you would like to contribute, please follow these steps:
|
|
|
|
1. Fork the repository.
|
|
2. Create a new branch (`git checkout -b feature-branch`).
|
|
3. Make your changes and commit them (`git commit -am 'Add feature'`).
|
|
4. Push the branch to your fork (`git push origin feature-branch`).
|
|
5. Create a pull request.
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|