-
Notifications
You must be signed in to change notification settings - Fork 58
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
5 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,5 @@ | ||
# CONTRIBUTING | ||
|
||
Here are some tips in case you want to contribute to this project. | ||
The BIDS website is moving and is developped on the main branch. | ||
|
||
## Requirements | ||
|
||
Install jekyll: https://jekyllrb.com/docs/installation/ | ||
|
||
If you are using a later version of Ruby yoy may encounter this error: when | ||
trying to serve the website locally. | ||
|
||
```bash | ||
require: cannot load such file -- webrick (LoadError) | ||
``` | ||
|
||
To fix this, you can install the `webrick` gem: | ||
|
||
```bash | ||
bundle add webrick | ||
``` | ||
|
||
More info here: https://talk.jekyllrb.com/t/load-error-cannot-load-such-file-webrick/5417/7 | ||
|
||
# Serve locally | ||
|
||
Run `bundle exec jekyll serve` in the root of the project. | ||
Please check it out there: https://github.com/bids-standard/bids-website/tree/main |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,5 @@ | ||
[![CircleCI](https://circleci.com/gh/bids-standard/bids-website.svg?style=shield)](https://circleci.com/gh/bids-standard/bids-website) | ||
[![Check Markdown links](https://github.com/bids-standard/bids-website/actions/workflows/check_md_links.yml/badge.svg)](https://github.com/bids-standard/bids-website/actions/workflows/check_md_links.yml) | ||
# Old BIDS website | ||
|
||
<img src="https://github.com/bids-standard/bids-specification/blob/master/BIDS_logo/BIDS_logo_white_transparent_background_crop.png#gh-dark-mode-only" alt="bids-logo" width="600"/> | ||
<img src="https://github.com/bids-standard/bids-specification/blob/master/BIDS_logo/BIDS_logo_black_transparent_background_crop.png#gh-light-mode-only" alt="bids-logo" width="600"/> | ||
The BIDS website is moving and is developped on the main branch. | ||
|
||
# BIDS website | ||
|
||
This is the repository for the Brain Imaging Data Structure (BIDS) website that is hosted at <https://bids.neuroimaging.io>. | ||
|
||
## Contributing to the BIDS website | ||
|
||
To contribute to the website, please submit an [issue](https://github.com/bids-standard/bids-website/issues) or send a [pull request](https://github.com/bids-standard/bids-website/pulls) to this repository. | ||
|
||
The more static website pages are located in `_pages`, the blog posts that are listed in a reverse chronological order (i.e., the newest content on top) are located in `_posts`. | ||
|
||
## Contributing to the BIDS specification | ||
|
||
The specification is hosted on [https://bids-specification.readthedocs.io](https://bids-specification.rtfd.io). To contribute to the specification, please submit an [issue](https://github.com/bids-standard/bids-specification/issues) or send a [pull request](https://github.com/bids-standard/bids-specification/pulls) on the [bids-specification](https://github.com/bids-standard/bids-specification) repository. | ||
|
||
## Asking questions about BIDS | ||
|
||
If you have questions how to apply BIDS to your dataset, how to use a shared BIDS dataset, or about tools to convert and/or handle BIDS datasets, please see the [getting started](https://bids.neuroimaging.io/get_started.html) page. | ||
Please check it out and contribute there: https://github.com/bids-standard/bids-website/tree/main |