DOC: Improve README sections

zapaishchykova / SegmentationReview

Slicer3D extension for rating using Likert-type score Deep-learning generated segmentations, with segment editor functionality. Created to speed up the validation process done by a clinician - the dataset loads in one batch with no need to load masks and volumes separately.

MIT License

25 stars 9 forks source link

DOC: Improve README sections #2

Closed jcfr closed 1 year ago

jcfr commented 1 year ago

Improve description wordings
Clarify installation steps to account for availability of the extension in the extensions manager
Move "Installing the extension" to the top
Add "Interface" section
Add "Maintainers" section

jcfr commented 1 year ago

To make the extension more useful and easier to use, where some additional suggestion:

while the collage include the example of analysis, user interface and input dataset structure is relevant in the context of the extensions manager. I don't think it should be included in the README, instead I suggest you include each independently.
an example of input dataset could be provided (including the annotation CVS file) could be provided.
the README should include details about the annotation.csv file (name of the column, expected value, etc ...)

zapaishchykova commented 1 year ago

Hi @jcfr, thank you for your suggestions. I just added those changes to the readme and added an example dataset (I used a Pixar Brain MRI dataset w brain mask segmentations from openFMRI and generated by hdbet, as it might be tricky for us to release the original one w brain malignancies)