Skip to content

Commit f2f2595

Browse files
authored
[DOC] add badges and link to doc (#99)
* add badges and link to doc * Update README.md * add badge doc
1 parent 5cb2c76 commit f2f2595

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
[![Deno build](https://github.com/bids-standard/bids-validator/actions/workflows/deno_tests.yml/badge.svg)](https://github.com/bids-standard/bids-validator/actions/workflows/deno_tests.yml)
2+
[![Web validator](https://github.com/bids-standard/bids-validator/actions/workflows/web_build.yml/badge.svg)](https://github.com/bids-standard/bids-validator/actions/workflows/web_build.yml)
3+
[![Documentation Status](https://readthedocs.org/projects/bids-validator/badge/?version=latest)](https://bids-validator.readthedocs.io/en/latest/?badge=latest)
4+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3688707.svg)](https://doi.org/10.5281/zenodo.3688707)
5+
16
# The BIDS Validator
27

38
The BIDS Validator is a web application, command-line utility,
@@ -76,3 +81,8 @@ To modify the schema a clone of bids-standard/bids-specification will need to be
7681
After changes to the schema have been made to a local copy the dereferenced single json file used by the validator will need to be built. The `bidsschematools` python package does this. It can be installed from pypi via pip or a local installation can be made. It lives in the specification repository here https://github.com/bids-standard/bids-specification/tree/master/tools/schemacode
7782

7883
The command to compile a dereferenced schema is `bst -v export --output src/schema.json` (this assumes you are in the root of the bids-specification repo). Once compiled it can be passed to the validator via the `-s` flag, `./bids-validator-deno -s <path to schema> <path to dataset>`
84+
85+
86+
## Documentation
87+
88+
The BIDS validator documentation is available on [Read the Docs](https://bids-validator.readthedocs.io/en/latest/).

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
88

99
project = 'BIDS Validator'
10-
copyright = '2024, BIDS Contributors'
10+
copyright = 'BIDS Contributors'
1111
author = 'BIDS Contributors'
1212

1313
# -- General configuration ---------------------------------------------------

0 commit comments

Comments
 (0)