search

ejh243 / BrainFANS

Other
8 stars 4 forks source link

[Enhancement suggestion]: Create README file template for projects/pipelines #28

Open marinafloresp opened 7 months ago

marinafloresp commented 7 months ago

Contact Details

m.flores-payan@exeter.ac.uk

Enhancement suggestion

Create a README.md file template that can be used to document a pipeline or a project in order to facilitate their use by others in the group.

marinafloresp commented 7 months ago

Added README template draft to wiki. Any suggestions or changes are welcomed.

sof202 commented 7 months ago

This is great, the examples given and points to cover should make it much easier to keep consistency between README files. Could I suggest that we add a section that tells the reader what they should expect to obtain (results wise) upon completion of running the scripts in the pipeline?

Thank you for doing this Marina

marinafloresp commented 7 months ago

Yes, that is a good idea.