Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update README #331

Closed
5 tasks done
MicahGale opened this issue Jan 16, 2024 · 1 comment · Fixed by #573
Closed
5 tasks done

Update README #331

MicahGale opened this issue Jan 16, 2024 · 1 comment · Fixed by #573
Assignees
@MicahGale
Labels
code improvement A feature request that will improve the software and its maintainability, but be invisible to users. documentation Improvements or additions to documentation feature request An issue that improves the user interface. PyOpenSci / JOSS

Comments

@MicahGale
Copy link
Collaborator

MicahGale commented Jan 16, 2024 •
edited
Loading

Is your feature request related to a problem? Please describe.
The readme is starting to feel a bit dated.

Describe the solution you'd like
I think we should:

  • Update the features list
  • Consider adding more of a tutorial
  • Update the contribution guide
  • Remove the Version numbering scheme information from here.
  • Probably do research on what good README's are.
@MicahGale MicahGale added feature request An issue that improves the user interface. documentation Improvements or additions to documentation code improvement A feature request that will improve the software and its maintainability, but be invisible to users. labels Jan 16, 2024
This was referenced Jul 9, 2024
Merged
Closed
@MicahGale MicahGale mentioned this issue Aug 23, 2024
Merged
@MicahGale MicahGale self-assigned this Oct 16, 2024
@MicahGale
Copy link
Collaborator Author

MicahGale commented Oct 16, 2024 •
edited
Loading

From PyOpenSCi review:

  • Specific requested badges (specifically: Docs building, repostatus.org badge, Python versions supported)
  • Vignette from README not working locally. I have no foo.imcnp to compare too, maybe putting one in the demo directory and linking it might be nice
  • Citation information needed at the bottom of the README. I am guessing this will be the JOSS paper once approved so just an acknowledgment that you'll do this once MontePy is accepted should suffice to check this off.
  • Noting similar packages. You mention in the paper ARMI, WATTS, and MCNPy but they should also be mentioned on your README with a quick note about how MontePy is different.

@MicahGale MicahGale mentioned this issue Oct 16, 2024
Merged
1 task
@MicahGale MicahGale linked a pull request Oct 16, 2024 that will close this issue
331 update readme #573
Merged
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MicahGale MicahGale

Labels
code improvement A feature request that will improve the software and its maintainability, but be invisible to users. documentation Improvements or additions to documentation feature request An issue that improves the user interface. PyOpenSci / JOSS
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

331 update readme idaholab/MontePy
1 participant
@MicahGale