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

[JOSS Review] - dependencies section in README #5

Closed
ericfell opened this issue Oct 30, 2024 · 1 comment · Fixed by #8
Closed

[JOSS Review] - dependencies section in README #5

ericfell opened this issue Oct 30, 2024 · 1 comment · Fixed by #8

Comments

@ericfell
Copy link

Dear authors,

Can you also provide a Dependencies section in your root README.md listing the core dependencies? I find it most useful on a project README to quickly see which version(s) of Python is required.

This issue is related to openjournals/joss-reviews#7291
mxwalbert added a commit that referenced this issue Nov 18, 2024
@mxwalbert
docs: added a dependencies section. added admonitions in the basic us…
f2e0dae 
…age example and the GUI description. (#5)
@mxwalbert
Copy link
Owner

Dear @ericfell,
we added a dependencies section and included information about the available extras. We also added notes in the GUI descriptions, referring to the required gui extra.

@mxwalbert mxwalbert linked a pull request Jan 3, 2025 that will close this issue
1 joss review #8
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

1 joss review mxwalbert/cohesivm
2 participants
@ericfell @mxwalbert