Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[FIX] divide readme into 3 parts #374

Merged
merged 8 commits into from
Jan 6, 2020
Merged

[FIX] divide readme into 3 parts #374

Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8d889ea
divide readme into 3 parts
sappelhoff Nov 22, 2019
11fcc7f
Apply suggestions from code review
sappelhoff Dec 5, 2019
5026d4b
change heading
sappelhoff Dec 5, 2019
737d716
add supported modalities
sappelhoff Dec 6, 2019
49628ae
asking questions -> getting started
sappelhoff Dec 10, 2019
b33788a
Apply suggestions from code review
sappelhoff Dec 16, 2019
81b2c28
neurostars for everything not just technical
sappelhoff Dec 16, 2019
19b47d4
restructure according to @emdupre's proposal
sappelhoff Dec 16, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,30 @@ organisation of neuroimaging data.
In this repository, we develop the
[BIDS specification](https://bids-specification.readthedocs.io/en/latest/).

**Want to learn more about working with BIDS? Have a question, comment, or suggestion?**
Open or comment on one of our [NeuroStars issues](https://neurostars.org/tags/bids) or check out the [BIDS Starter Kit](https://github.com/bids-standard/bids-starter-kit)!
# Formatting your data with BIDS

To organize your data in BIDS, all you need is neuro data, a computer, and the
[BIDS specification](https://bids-specification.readthedocs.io/en/stable/).

BIDS currently supports MRI, MEG, EEG, iEEG, behavioral, and phsyiological data
sappelhoff marked this conversation as resolved.
Show resolved Hide resolved
and more modalities are being added continuously (see here for
[work in progress modalities](https://bids-specification.readthedocs.io/en/stable/06-extensions.html#bids-extension-proposals)).

As a dataset curator, the GitHub repository and all files therein can be safely ignored
to focus on the rendered content instead (see link above).
sappelhoff marked this conversation as resolved.
Show resolved Hide resolved
The specification is provided in the form of a webpage, built using
[MkDocs](https://www.mkdocs.org/) and [Read the Docs](https://readthedocs.org/).

# Getting started

*Want to learn more about working with BIDS? Have a question, comment, or suggestion?*
Copy link
Collaborator

@emdupre emdupre Dec 17, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Light suggestion here would be to convert this into a sub-heading, or add one directly above it. Something like:

## Where to go to learn more


1. Read some introductory material, most likely the very basic problems have already been addressed!
sappelhoff marked this conversation as resolved.
Show resolved Hide resolved
- [BIDS Starter Kit](https://github.com/bids-standard/bids-starter-kit) for tutorials, wikis, templates, ...
2. Post your question in one of several channels where BIDS members are active
- the [NeuroStars](https://neurostars.org/tags/bids) discourse forum, for technical questions
sappelhoff marked this conversation as resolved.
Show resolved Hide resolved
- the [Google group](https://groups.google.com/forum/#!forum/bids-discussion), for broader discussions surrounding BIDS
- the [specification repository issue page](https://github.com/bids-standard/bids-specification/issues), if you found inconsistencies, typos, or other issues with the BIDS specification itself

# Contributing to BIDS

Expand Down