diff --git a/bids-validator/README.md b/bids-validator/README.md index 7e61645d3..6dc051cf1 100644 --- a/bids-validator/README.md +++ b/bids-validator/README.md @@ -56,7 +56,9 @@ [Conda package](https://anaconda.org/conda-forge/bids-validator). 1. Open a Python terminal and type: `python` 1. Import the BIDS Validator package `from bids_validator import BIDSValidator` - 1. Check if a file is BIDS compatible `BIDSValidator().is_bids('path/to/a/bids/file')` + 1. Check if a file is BIDS compatible `BIDSValidator().is_bids('/relative/path/to/a/bids/file')` + 1. Note, the file path must be relative to the root of the BIDS dataset, and + a leading forward slash `/` must be added to the file path. ## Support @@ -405,6 +407,9 @@ for filepath in filepaths: print(validator.is_bids(filepath)) # will print True, and then False ``` +Note, the file path must be relative to the root of the BIDS dataset, and a +leading forward slash `/` must be added to the file path. + ## Development To develop locally, clone the project and run `npm install` from the project