Skip to content

Conversation

@amzhao16
Copy link
Collaborator

Update ReadME so i can be gin with release!

@amzhao16 amzhao16 requested a review from sarahmish April 26, 2025 20:21
Copy link
Contributor

@sarahmish sarahmish left a 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:

[![Development Status](https://img.shields.io/badge/Development%20Status-2%20--%20Pre--Alpha-yellow)](https://pypi.org/search/?c=Development+Status+%3A%3A+2+-+Pre-Alpha)
[![PyPI Shield](https://img.shields.io/pypi/v/pygridsim.svg)](https://pypi.python.org/pypi/pygridsim)
[![Downloads](https://pepy.tech/badge/pygridsim)](https://pepy.tech/project/pygridsim)
[![Run Tests](https://github.com/DAI-Lab/PyGridSim/actions/workflows/tests.yml/badge.svg)](https://github.com/DAI-Lab/PyGridSim/actions/workflows/tests.yml)

@amzhao16 amzhao16 requested a review from sarahmish April 27, 2025 17:14
Copy link
Contributor

@sarahmish sarahmish left a 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
Comment on lines 11 to 12
[![Github Actions Shield](https://img.shields.io/github/workflow/status/amzhao/PyGridSim/Run%20Tests)](https://github.com/amzhao/PyGridSim/actions)
[![Coverage Status](https://codecov.io/gh/amzhao/PyGridSim/branch/master/graph/badge.svg)](https://codecov.io/gh/amzhao/PyGridSim)
Copy link
Contributor

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/
Copy link
Contributor

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

@amzhao16 amzhao16 requested a review from sarahmish April 27, 2025 23:04
Copy link
Contributor

@sarahmish sarahmish left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM @amzhao16!

@amzhao16 amzhao16 merged commit cf10405 into main Apr 28, 2025
36 checks passed
@amzhao16 amzhao16 self-assigned this Apr 28, 2025
@amzhao16 amzhao16 added the documentation Improvements or additions to documentation label Apr 28, 2025
@amzhao16 amzhao16 added this to the 0.1.0 milestone Apr 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants