neuroinformatics-unit / NeuroBlueprint

Lightweight data specification for systems neuroscience, inspired by BIDS.
http://neuroblueprint.neuroinformatics.dev/
Creative Commons Attribution 4.0 International
17 stars 1 forks source link

Update README.md #14

Closed JoeZiminski closed 1 year ago

JoeZiminski commented 1 year ago

Update readme to align with the new website (https://neuroinformatics.dev/projects/swc-bids.html) and mention the ongoing proposal to extend BIDS to non-human research.

I started basically copying verbatim from website with a few extra additions, but maybe this would read strangely if you navigate straight from the website, so changed it up a little.

adamltyson commented 1 year ago

I started basically copying verbatim from website with a few extra additions, but maybe this would read strangely if you navigate straight from the website, so changed it up a little.

In general I don't see any reason why we can't have the same info in >1 place.

Unless I'm missing something, this PR changes the readme to better match the NIU website, but then differs from the SWC-BIDS site. I would favour the information on the NIU site being very basic (and hardly ever needing to be updated) and then the repo readme and project website (ideally the same content) be more in-depth.

JoeZiminski commented 1 year ago

I started basically copying verbatim from website with a few extra additions, but maybe this would read strangely if you navigate straight from the website, so changed it up a little.

In general I don't see any reason why we can't have the same info in >1 place.

Unless I'm missing something, this PR changes the readme to better match the NIU website, but then differs from the SWC-BIDS site. I would favour the information on the NIU site being very basic (and hardly ever needing to be updated) and then the repo readme and project website (ideally the same content) be more in-depth.

If I understand correctly, I believe the landing page of the swc-bids website links to the GitHub readme (so it should change accordingly)

adamltyson commented 1 year ago

If I understand correctly, I believe the landing page of the swc-bids website links to the GitHub readme (so it should change accordingly)

Oh perfect. In that case LGTM.