search

GSTT-CSC / hazen

Quality assurance framework for Magnetic Resonance Imaging
https://github.com/GSTT-CSC/hazen
Apache License 2.0
22 stars 12 forks source link

separate READme for users and developers #348

Closed sophie22 closed 1 year ago

sophie22 commented 1 year ago

Current READme file presents instructions for both users and developers and different sections apply to either. I suggest having a separate "users readme" which would be the main one currently available and the developer/contributor specific instructions would be moved to a new "developer READme".

@tomaroberts let me know what you think

sophie22 commented 1 year ago

to some extent the CONTRIBUTING.md already appears to serve a similar purpose, but I would like to more clearly separate dev instructions from the main READme. The developer READme could also include a high-level overview of the code architecture to help orientate future contributors on how and where to make their changes.

sophie22 commented 1 year ago

partly relates to #212 and #300 and #303