Make installation instructions more prominent in the documentation for users

[kinow]

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.

• I am not sure whether I want a library or application. Maybe add a line somewhere explaining the differences and different use cases? #108
• Is Carnival limited to Groovy + Gradle? Or would it work with other JVM languages and other build tools like Maven or Ant/Ivy? #109
• Easier docker example #110

[kinow]

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)?

[hjwilli]

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!

[kinow]

Thank you @hjwilli ! I will start the review process again over this weekend. Thank you!

[kinow]

The installation/usage instructions look good to me. I've used Groovy+Grapes in the past, and I believe users and readers would be able to read Grapes' docs (if needed) and follow the steps in the new docs. Thanks @hjwilli ! Closing.