From 8d889eaa52ba2be17f891a6897b83f0b814505bb Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Fri, 22 Nov 2019 16:38:22 +0100 Subject: [PATCH 1/8] divide readme into 3 parts --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b749e2b6d4..7580154a0e 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,26 @@ 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)! +# Using BIDS + +To use BIDS, all you need is neuro data, a computer, and the +[BIDS specification](https://bids-specification.readthedocs.io/en/stable/). + +As a user, the GitHub repository and all files therein can be safely ignored +to focus on the rendered content instead (see link above). +The specification is provided in the form of a webpage, built using +[MkDocs](https://www.mkdocs.org/) and [Read the Docs](https://readthedocs.org/). + +# Asking Questions + +If you have a question about BIDS, you have several options: + +1. Read some introductory material, most likely the very basic problems have already been addressed! + - [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 + - 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 From 11fcc7fdd13659bf4376c228ee033064ef4ea6e1 Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Thu, 5 Dec 2019 15:09:46 +0100 Subject: [PATCH 2/8] Apply suggestions from code review Co-Authored-By: Chris Markiewicz Co-Authored-By: Elizabeth DuPre --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7580154a0e..adf9de6a08 100644 --- a/README.md +++ b/README.md @@ -13,17 +13,17 @@ In this repository, we develop the # Using BIDS -To use BIDS, all you need is neuro data, a computer, and the +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/). -As a user, the GitHub repository and all files therein can be safely ignored +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). The specification is provided in the form of a webpage, built using [MkDocs](https://www.mkdocs.org/) and [Read the Docs](https://readthedocs.org/). # Asking Questions -If you have a question about BIDS, you have several options: +*Want to learn more about working with BIDS? Have a question, comment, or suggestion?* 1. Read some introductory material, most likely the very basic problems have already been addressed! - [BIDS Starter Kit](https://github.com/bids-standard/bids-starter-kit) for tutorials, wikis, templates, ... From 5026d4ba818264057b92520083106da91b3ff2c9 Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Thu, 5 Dec 2019 15:19:14 +0100 Subject: [PATCH 3/8] change heading --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index adf9de6a08..b5403673b6 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ organisation of neuroimaging data. In this repository, we develop the [BIDS specification](https://bids-specification.readthedocs.io/en/latest/). -# Using BIDS +# 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/). From 737d716c3f8865e813cb83cfed0a03d711034008 Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Fri, 6 Dec 2019 11:16:45 +0100 Subject: [PATCH 4/8] add supported modalities --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index b5403673b6..f91c76114a 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,10 @@ In this repository, we develop the 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 +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). The specification is provided in the form of a webpage, built using From 49628aee3d9b0dc7ff8dfb2263d46443f83513d4 Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Tue, 10 Dec 2019 14:27:11 +0100 Subject: [PATCH 5/8] asking questions -> getting started --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f91c76114a..8ca1c6ea03 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ to focus on the rendered content instead (see link above). The specification is provided in the form of a webpage, built using [MkDocs](https://www.mkdocs.org/) and [Read the Docs](https://readthedocs.org/). -# Asking Questions +# Getting started *Want to learn more about working with BIDS? Have a question, comment, or suggestion?* From b33788a1425ce183036de1f576175e3d6ede4349 Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Mon, 16 Dec 2019 10:34:19 +0100 Subject: [PATCH 6/8] Apply suggestions from code review Co-Authored-By: Elizabeth DuPre --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8ca1c6ea03..5632355c6c 100644 --- a/README.md +++ b/README.md @@ -16,12 +16,12 @@ In this repository, we develop the 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 +BIDS currently supports MRI, MEG, EEG, iEEG, behavioral, and physiological data 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). +to focus on [the rendered content](https://bids-specification.readthedocs.io/en/stable/). The specification is provided in the form of a webpage, built using [MkDocs](https://www.mkdocs.org/) and [Read the Docs](https://readthedocs.org/). From 81b2c28e544af11dba6d996145eedb157bf01ab3 Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Mon, 16 Dec 2019 10:40:29 +0100 Subject: [PATCH 7/8] neurostars for everything not just technical --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5632355c6c..f9dc2d10f0 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ The specification is provided in the form of a webpage, built using 1. Read some introductory material, most likely the very basic problems have already been addressed! - [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 + - the [NeuroStars](https://neurostars.org/tags/bids) discourse forum - 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 From 19b47d4a6dd5b188b93454476b7fbce387749ef7 Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Mon, 16 Dec 2019 10:45:36 +0100 Subject: [PATCH 8/8] restructure according to @emdupre's proposal --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f9dc2d10f0..7db8b83faa 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ organisation of neuroimaging data. In this repository, we develop the [BIDS specification](https://bids-specification.readthedocs.io/en/latest/). -# Formatting your data with BIDS +# When to use 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/). @@ -20,13 +20,13 @@ BIDS currently supports MRI, MEG, EEG, iEEG, behavioral, and physiological data 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](https://bids-specification.readthedocs.io/en/stable/). +# Formatting your data with BIDS + +As a dataset curator, the GitHub repository and all files therein can be safely ignored. +Users should focus on [the rendered content](https://bids-specification.readthedocs.io/en/stable/). 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?* 1. Read some introductory material, most likely the very basic problems have already been addressed!