psych-214-fall-2016 / project-red

Other
1 stars 7 forks source link

README files for code #35

Closed ctseng12 closed 7 years ago

ctseng12 commented 7 years ago

Are we making a README file for each code subfolder (i.e., anatomical preprocessing, fct preprocessing, etc.) or a single README file in the code folder for explanations of what we're doing in each section?

zzbalews commented 7 years ago

Could we put everything in the report? That might be a good place for details since they're probably relevant for whatever results we're discussing. And then the top level README doesn't get bogged down.

On Tue, Dec 13, 2016 at 3:55 PM, ctseng12 notifications@github.com wrote:

Are we making a README file for each code subfolder (i.e., anatomical preprocessing, fct preprocessing, etc.) or a single README file in the code folder for explanations of what we're doing in each section?

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/psych-214-fall-2016/project-red/issues/35, or mute the thread https://github.com/notifications/unsubscribe-auth/AM7eKra-cNMa-iOcg4Y1UhPDE54dcSbjks5rHzBjgaJpZM4LMX6V .

ctseng12 commented 7 years ago

Maybe? I interpreted Matthew's response on piazza to mean that the report should be super simple/bare bones, but it also makes the most sense to me to put it there.

mpnagle commented 7 years ago

Matthew says no, readme info goes into the report.