-
Notifications
You must be signed in to change notification settings - Fork 0
Readme update #11
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
Readme update #11
Conversation
sarahmish
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @amzhao16, I have a few comments.
For the badges, please use the following:
[](https://pypi.org/search/?c=Development+Status+%3A%3A+2+-+Pre-Alpha)
[](https://pypi.python.org/pypi/pygridsim)
[](https://pepy.tech/project/pygridsim)
[](https://github.com/DAI-Lab/PyGridSim/actions/workflows/tests.yml)
sarahmish
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Last two edits then it should be good to go @amzhao16!
README.md
Outdated
| [](https://github.com/amzhao/PyGridSim/actions) | ||
| [](https://codecov.io/gh/amzhao/PyGridSim) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove these lines too
README.md
Outdated
| - Documentation: https://amzhao.github.io/PyGridSim | ||
| - Homepage: https://github.com/amzhao/PyGridSim | ||
| - Documentation: https://dtail.gitbook.io/pygridsim | ||
| - Homepage: https://dai.lids.mit.edu/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
homepage is the package homepage: https://github.com/DAI-Lab/PyGridSim/
not the lab's website
sarahmish
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM @amzhao16!
Update ReadME so i can be gin with release!