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 / Explicitly list requirements for library #14

Closed
jmansour opened this issue Jun 13, 2023 · 1 comment
Closed

JOSS / Explicitly list requirements for library #14

jmansour opened this issue Jun 13, 2023 · 1 comment

Comments

@jmansour
Copy link

Please add an explicit "Requirements" section to your README.md listing dependencies, including the necessary compiler.

Please also add optional requirements which may be necessary for plotting results (Python/Numpy/Matplotlib) and testing.
@jmansour jmansour mentioned this issue Jun 13, 2023
Closed
@polycfd
Copy link
Collaborator

polycfd commented Jun 13, 2023

Nice idea! I've added a requirements section to the main README.md and the documentation (see Section 2.1).

@polycfd polycfd closed this as completed Jun 13, 2023
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

No branches or pull requests
1 participant
@jmansour