Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update readme #545

Merged
merged 3 commits into from
Sep 4, 2024
Merged

docs: update readme #545

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bed2ebf
docs: update readme
korikuzma Sep 4, 2024
a6314a1
Update README.md
korikuzma Sep 4, 2024
6533860
Update README.md
korikuzma Sep 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,10 @@ The VRS model is the product of the [GA4GH Variation Representation group](https

## Using the schema

The schema is available in the [schema/](./schema/) directory, in both yaml and json versions.
It conforms to JSON Schema draft-07. For a list of libraries that support JSON schema,
see [JSONSchema>Implementations](https://json-schema.org/implementations.html).
The schema is available in the [schema/](./schema/) directory, in both yaml and json versions.
It conforms to JSON Schema Draft 2020-12. For a list of
libraries that support JSON schema, see
[JSONSchema>Tools](https://json-schema.org/tools).

## Installing for development

Expand All @@ -52,15 +53,15 @@ If you already cloned the repo, but forgot to include `--recurse-submodules` you

## Contributing to the schema

VRS uses [vrs-source.yaml](./schema//vrs/vrs-source.yaml) as the source document for JSON Schema.
VRS uses [vrs-source.yaml](./schema/vrs/vrs-source.yaml) as the source document for JSON Schema.

To create the corresponding def and json files after making changes to the source document, from the root directory:

cd schema
make all

> _Note: We have a custom pre-commit hook to run these commands after you stage a source
> document_
> *Note: We have a custom pre-commit hook to run these commands after you stage a source
> document*

## Contributing to the docs

Expand Down
Loading