Skip to content

Conversation

@technic960183
Copy link
Member

Summary

This pull request includes significant updates to the README.md file to improve its presentation about the status of the GAMER project. The changes enhance the readability, add badges for project status, and provide detailed sections for getting started, documentation, and citation.

Changes

Improved Presentation

  • Reformatted the project title with HTML for better alignment and styling.
  • Added badges for GitHub release, DOI, license, number of contributors, commit activity, and citations to provide quick access to project status and metrics.

Citation Information

  • Included a detailed BibTeX entry for citing the GAMER code paper in research, along with a link to the paper.

Notes

Copy link
Collaborator

@ChunYen-Chen ChunYen-Chen left a comment

Choose a reason for hiding this comment

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

@technic960183 Looks great! Thanks for the contribution.

Copy link
Contributor

@hyschive hyschive left a comment

Choose a reason for hiding this comment

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

@technic960183 Thanks for the contribution! I've left some minor suggestions. I would be happy to merge it once they are addressed.

Copy link
Member Author

@technic960183 technic960183 left a comment

Choose a reason for hiding this comment

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

@hyschive Thanks for the review.
I slightly chagned the layout of the header to fit more devices. Please check it.
Also, what source of citation numbers do you want to use?

Copy link
Contributor

@hyschive hyschive left a comment

Choose a reason for hiding this comment

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

I'll merge it right away once you update the citation counts as discussed here.

@hyschive hyschive merged commit cf84c03 into gamer-project:main May 7, 2025
@technic960183 technic960183 deleted the new_readme branch May 7, 2025 07:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update README

3 participants