Skip to content

Commit

Permalink
Fill in URLs in the README.md
Browse files Browse the repository at this point in the history
Otherwise github does not render them nicely and people might not know where to go
  • Loading branch information
yarikoptic committed Nov 26, 2024
1 parent 9e8da14 commit 1e4664a
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@

The BIDS Validator is a web application, command-line utility,
and Javascript/Typescript library for assessing compliance with the
[Brain Imaging Data Structure][BIDS] standard.
[Brain Imaging Data Structure (BIDS)](https://bids.neuroimaging.io/) standard.

## Getting Started

In most cases,
the simplest way to use the validator is to browse to the [BIDS Validator][] web page:
the simplest way to use the validator is to browse to the [BIDS Validator][https://bids-standard.github.io/bids-validator/] web page:

![The web interface to the BIDS Validator with the "Select Dataset Files" button highlighted.
(Dark theme)](docs/_static/web_entrypoint_dark.png#gh-dark-mode-only)
Expand All @@ -23,8 +23,8 @@ The web validator runs in-browser, and does not transfer data to any remote serv

In some contexts, such as when working on a remote server,
it may be easier to use the command-line.
The BIDS Validator can be run with the [Deno] runtime
(see [Deno - Installation][] for detailed installation instructions):
The BIDS Validator can be run with the [Deno](https://deno.com/) runtime
(see [Deno - Installation](https://docs.deno.com/runtime/getting_started/installation/) for detailed installation instructions):

```shell
deno run -ERN jsr:@bids/validator
Expand Down Expand Up @@ -85,4 +85,4 @@ The command to compile a dereferenced schema is `bst -v export --output src/sche

## Documentation

The BIDS validator documentation is available on [Read the Docs](https://bids-validator.readthedocs.io/en/latest/).
The BIDS validator documentation is available on [Read the Docs](https://bids-validator.readthedocs.io/en/latest/).

0 comments on commit 1e4664a

Please sign in to comment.