Be friendly to your users:
Add comments and tutorials to your code
Giovanni Volpe
MTL BrainHack School 2019, Montreal, 22 August 2019
https://brainhackmtl.github.io/school2019/
When releasing a software package, it is critical to provide potential users with all the information they need to help them using it.
Using the example of Braph — a software we recently developed to study brain connectivity http://braph.org/ —, I’ll illustrate how we have commented the code, created a website and off-line documentation, and recoded video tutorials.
I’ll conclude with some practical advice and some best practices.