JOSS: Usage instructions

klevis-a / kinematics-vis

JavaScript application for visualizing and analyzing shoulder joint kinematics

MIT License

4 stars 2 forks source link

Closed engnadeau closed 3 years ago

engnadeau commented 3 years ago

The README currently only contains installation instructions
The README (and potentially the paper) should also include a Usage section that guides the user into how to use the software, especially considering that:
- "Human motion analysis is a complex topic. Biomechanists, clinicians, and trainees typically accept the results of research papers without having a consistent way to validate these results"
- "It has previously been shown that incorrect usage of Euler/Cardan sequences can significantly misrepresent human motion"
- "biomechanics researchers and clinicians with a limited mathematical background"
cc https://github.com/openjournals/joss-reviews/issues/3490

klevis-a commented 3 years ago

I had included usage instructions in the UI. See https://shouldervis.chpc.utah.edu/kinevis/main.html as an example. I can also include them in the README if you think it is necessary. Please let me know.

engnadeau commented 3 years ago

ah, i completely missed the ? at the top

yeah, it'd be great if the README at least directed the user where to look

klevis-a commented 3 years ago

Yep, exactly. It's not immediately obvious - I was trying to conserve screen real estate. Sure, I can add that to the README.

klevis-a commented 3 years ago

engnadeau commented 3 years ago

could you also provide a screenshot similar to mine in the README to visually show people where the help menu is

klevis-a commented 3 years ago