Skip to content

Commit

Permalink
[DOC] add badges and link to doc (#99)
Browse files Browse the repository at this point in the history
* add badges and link to doc

* Update README.md

* add badge doc
  • Loading branch information
Remi-Gau authored Nov 9, 2024
1 parent 5cb2c76 commit f2f2595
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
[![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)
[![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)
[![Documentation Status](https://readthedocs.org/projects/bids-validator/badge/?version=latest)](https://bids-validator.readthedocs.io/en/latest/?badge=latest)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3688707.svg)](https://doi.org/10.5281/zenodo.3688707)

# The BIDS Validator

The BIDS Validator is a web application, command-line utility,
Expand Down Expand Up @@ -76,3 +81,8 @@ To modify the schema a clone of bids-standard/bids-specification will need to be
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

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>`


## Documentation

The BIDS validator documentation is available on [Read the Docs](https://bids-validator.readthedocs.io/en/latest/).
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'BIDS Validator'
copyright = '2024, BIDS Contributors'
copyright = 'BIDS Contributors'
author = 'BIDS Contributors'

# -- General configuration ---------------------------------------------------
Expand Down

0 comments on commit f2f2595

Please sign in to comment.