Skip to content

Commit

Permalink
DOC: Bring README up to date with current repo
Browse files Browse the repository at this point in the history
  • Loading branch information
effigies committed Nov 7, 2024
1 parent e28cada commit 6b17f6a
Showing 1 changed file with 2 additions and 8 deletions.
10 changes: 2 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,13 @@ Pass the `--json` flag to see the issues in detail.

### Development tools

From the repository root, use `bids-validator/bids-validator-deno` to run with all permissions enabled by default:
From the repository root, use `./local-run` to run with all permissions enabled by default:

```shell
# Run from within the /bids-validator directory
cd bids-validator
# Run validator:
./bids-validator-deno path/to/dataset
./local-run path/to/dataset
```

## Schema validator test suite
Expand All @@ -69,12 +69,6 @@ deno test --allow-env --allow-read --allow-write src/

This test suite includes running expected output from bids-examples and may throw some expected failures for bids-examples datasets where either the schema or validator are misaligned with the example dataset while under development.

## Refreshing latest specification

If you are validating with the latest specification instead of a specific version, the validator will hold onto a cached version. You can request the newest version by adding the `--reload` argument to obtain the newest specification definition.

`deno run --reload=https://bids-specification.readthedocs.io/en/latest/schema.json src/main.ts`

## Modifying and building a new schema

To modify the schema a clone of bids-standard/bids-specification will need to be made. README and schema itself live here https://github.com/bids-standard/bids-specification/tree/master/src/schema.
Expand Down

0 comments on commit 6b17f6a

Please sign in to comment.