From 4a496e2af0d638ce15679bd4ce38bda63c3c1b37 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julia=20Guiomar=20Niso=20Gal=C3=A1n?= Date: Tue, 21 Nov 2023 12:06:02 +0100 Subject: [PATCH] [DOC] Update README.md (#588) * Update README.md Add "How to cite" * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update README.md * update citation * update version * update version * update README * update DOC README --------- Co-authored-by: Remi Gau Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- CITATION.cff | 2 +- Makefile | 2 +- README.md | 27 ++++++++++------ docs/source/general_information.md | 52 ------------------------------ version.txt | 2 +- 5 files changed, 21 insertions(+), 64 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index 27d6e67c..ec0ff309 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -4,7 +4,7 @@ cff-version: 1.2.0 title: bids-matlab -version: 0.1.0dev +version: 0.2.0 license: MIT diff --git a/Makefile b/Makefile index 36e7eff2..a496adcc 100644 --- a/Makefile +++ b/Makefile @@ -2,7 +2,7 @@ clean: rm version.txt -version.txt: CITATION.cff +version.txt: clean CITATION.cff grep -w "^version" CITATION.cff | sed "s/version: /v/g" > version.txt manual: diff --git a/README.md b/README.md index a2a09739..f9621378 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,8 @@ addpath('bids-matlab'); ### Get the latest features -Stable versions should be fetched from a specific version tag. +Stable versions should be fetched from a specific version tag +or from the [Mathworkds file exchange](https://nl.mathworks.com/matlabcentral/fileexchange/93740-bids-matlab). A new version of BIDS matlab should be released for each new version of the BIDS specification to allow for a support of new BIDS datatypes or features. @@ -85,14 +86,6 @@ Or clone it: git clone --branch main https://github.com/bids-standard/bids-matlab.git ``` -Or you can check it out the `main` branch -after the adding this official bids-matlab repository as a remote. - -``` -git add remote upstream https://github.com/bids-standard/bids-matlab.git -git checkout upstream/main -``` - ## Features ### What this toolbox can do @@ -231,6 +224,22 @@ on the brainhack mattermost [resting state analysis from OMEGA datasets](https://neuroimage.usc.edu/brainstorm/Tutorials/RestingOmega#BIDS_specifications) ) +## How to cite +To credit BIDS-Matlab in your work, please cite the [Zenodo archive](https://zenodo.org/record/5910584), +which points to a permanent record of all BIDS-Matlab versions. +We encourage you to mention the specific version you used. + +```bibtex +@software{Gau_bids-matlab, +author = {Gau, RΓ©mi and Flandin, Guillaume and Janke, Andrew and Duval, Tanguy and Oostenveld, Robert and Madan, Christopher and Niso, Guiomar and Szczepanik, MichaΕ‚ and Mutsaerts, Henk and Beliy, Nikita and Norgaard, Martin and Pernet, Cyril and Chrisophe, Phillips and Shahzad, Iqra and Botvinik-Nezer, Rotem and Barilari, Marco and Battal, Ceren and MacLean, MichΓ¨le and Caron-Guyon, Jeanne}, +license = {MIT}, +title = {{bids-matlab}}, +url = {https://github.com/bids-standard/bids-matlab}, +doi = https://doi.org/10.5281/zenodo.3363985 +} +``` + + ## Contributing If you want to contribute make sure to check our [contributing guidelines](CONTRIBUTING.md) diff --git a/docs/source/general_information.md b/docs/source/general_information.md index 964d9f97..058a27bf 100644 --- a/docs/source/general_information.md +++ b/docs/source/general_information.md @@ -1,17 +1,3 @@ - - - - -[![miss_hit](https://github.com/bids-standard/bids-matlab/actions/workflows/miss_hit.yml/badge.svg)](https://github.com/bids-standard/bids-matlab/actions/workflows/miss_hit.yml) -[![tests_matlab](https://github.com/bids-standard/bids-matlab/actions/workflows/run_tests_matlab.yml/badge.svg)](https://github.com/bids-standard/bids-matlab/actions/workflows/run_tests_matlab.yml) -[![tests_octave](https://github.com/bids-standard/bids-matlab/actions/workflows/run_tests_octave.yml/badge.svg)](https://github.com/bids-standard/bids-matlab/actions/workflows/run_tests_octave.yml) -[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/bids-standard/bids-matlab/main?urlpath=demos) -[![View bids-matlab on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://nl.mathworks.com/matlabcentral/fileexchange/93740-bids-matlab) -[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5910584.svg)](https://doi.org/10.5281/zenodo.5910584) -[![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors-) - - - # BIDS for MATLAB / Octave This repository aims at centralising MATLAB/Octave tools to interact with @@ -178,41 +164,3 @@ removed. [group analysis from a MEG visual dataset](https://neuroimage.usc.edu/brainstorm/Tutorials/VisualGroup), [resting state analysis from OMEGA datasets](https://neuroimage.usc.edu/brainstorm/Tutorials/RestingOmega#BIDS_specifications) ) - -## Contributors ✨ - -Thanks goes to these wonderful people -([emoji key](https://allcontributors.org/docs/en/emoji-key)): - - - - - - - - - - - - - - - - - - - - - - - -

Guillaume
πŸ’» 🎨 πŸ“– πŸ’‘ πŸ€” πŸš‡ 🚧 πŸ’¬ πŸ‘€ ⚠️
Remi Gau
πŸ’» 🎨 πŸ“– πŸ’‘ πŸ€” 🚧 πŸ’¬ πŸ‘€ ⚠️
Andrew Janke
πŸ’» 🎨 πŸ“– πŸ€” πŸ‘€ πŸš‡
tanguyduval
πŸ’» πŸ“– πŸ€”
Robert Oostenveld
πŸ’» πŸ“– πŸ€” πŸ‘€
Christopher Madan
πŸ–‹
Julia Guiomar Niso GalΓ‘n
πŸ‘€

MichaΕ‚ Szczepanik
πŸš‡ πŸ€” πŸ’»
Henk Mutsaerts
πŸ’» πŸ€”
Nikita Beliy
πŸ’» πŸ€” πŸ‘€
Martin Norgaard
πŸ› πŸ€”
Cyril Pernet
πŸ’» πŸ€”
Christophe Phillips
πŸ€”
CerenB
πŸ‘€
- - - - - - -This project follows the -[all-contributors](https://github.com/all-contributors/all-contributors) -specification. Contributions of any kind welcome! diff --git a/version.txt b/version.txt index e1847fa9..1474d00f 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -v0.1.0dev +v0.2.0