Skip to content

Change README.md #2852

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Conversation

lighting9999
Copy link
Contributor

@lighting9999 lighting9999 commented Aug 22, 2025

Update Summary

This PR updates the README.md with the following improvements:

  • Added "How to Run" guide – includes steps to clone the repository and run scripts.
  • Dependency installation notes – explained the usage of requirements.txt, clarified that some scripts only rely on the Python standard library, and that not all dependencies may be fully listed.
  • Python version support update – currently supports Python 3.6+, with plans to gradually raise the minimum version to Python 3.9+.
  • Preserved existing sections – kept the project overview, MIT license, and usage permissions.

These updates make the project more user-friendly and provide clearer instructions for newcomers.

fix format.because readme is not perfect.
@lighting9999 lighting9999 marked this pull request as draft August 22, 2025 08:02
@lighting9999 lighting9999 marked this pull request as ready for review August 22, 2025 08:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant