search

IBT-FMI / SAMRI

Small Animal Magnetic Resonance Imaging via Python.
GNU General Public License v3.0
43 stars 27 forks source link

default readme in BIDS dataset #115

Open Remi-Gau opened 2 years ago

Remi-Gau commented 2 years ago

We (BIDS maintainers) are trying to see if we can improve the quality of the average README in BIDS dataset. Those tend to be pretty thin and are missing some information we would like to see there even if it can be formalized "yet" into the BIDS specification.

Hoping to leverage the bids converters to help to do.

So I am going around the different BIDS converters repo to see if we can start improving the default README they put in a the BIDS dataset.

There is template that is provided in the BIDS starter kit: https://github.com/bids-standard/bids-starter-kit/blob/main/templates/README.MD

Some possible options:

  1. use this template is
  2. use a subset of it
  3. add a link to the template README
  4. something else (a mix of 2 and 3?)

What do you think? I can try to open a PR if you want.

Also let us know if you think that the template README in the starter kit could / should be improved .

TheChymera commented 2 years ago

@Remi-Gau

What do you think? I can try to open a PR if you want.

That would be amazing, thank you for offering.