search

easyreporting / fmri_reporting

Easy best practice reporting for your fMRI study!
MIT License
1 stars 1 forks source link

Review README #5

Closed cmaumet closed 7 years ago

cmaumet commented 7 years ago

Hello,

What did you think of the README of this repository? Was there anything that you think could be clarified? Would you have suggestions for improvements?

https://github.com/cmaumet/fmri_reporting/blob/master/README.md

djmitche commented 7 years ago

It's not entirely clear that it's a course -- I have to read a few paragraphs before I find that despite the tagline, this is not a tool to help me report. Maybe "Learn how to.." in the tagline would help?

cmaumet commented 7 years ago

Thank you @djmitche! That's a very good point!

I have tried to update the one-line description and came up with "Practical solutions to follow open science best practices in fMRI research. Learn the tools to make your fMRI study transparent!", I also thought of something along the lines of "How to comply with transparency best practices with little overhead?" but not sure this is better?

I would love to get your feedback on this possible update. The full work-in-progress README can be seen at https://github.com/easyreporting/fmri_reporting/blob/5696fff97657e7ff15bea6973acd2a6682b5c3ec/README.md (part of #10).

cmaumet commented 7 years ago

Updates were implemented in #10. Thank you @djmitche!