Make installation instructions more prominent in the documentation for users
Closed this issue · 4 comments
Hi,
For the JOSS paper review, I looked for the installation instructions of Carnival.
Initially it wasn't clear whether it was published to Maven Central or not, whether I should user Docker, etc.
I think now I've found the docs to install it, under the getting started page.
This issue is related to the final pending items in my review
Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
Functionality: Have the functional claims of the software been confirmed?
Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
Hi @kinow, I believe these issues have now all been addressed, and the documentation on how to use carnival in a project should be clearer:
https://carnival-data.github.io/carnival/#using-carnival
Please let us know if this is sufficient!