Skip to content

Commit

Permalink
docs: Explain how to test and how to disable testing
Browse files Browse the repository at this point in the history
  • Loading branch information
l0b0 committed Nov 19, 2021
1 parent 6826a0c commit ecd5a75
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,10 @@ It only checks the contained items/collections, but not the other parts of the r
1. `git clone https://github.com/stac-utils/stac-node-validator` to clone the repo
2. `cd stac-node-validator` to switch into the new folder created by git
3. `npm install` to install dependencies
4. Run the commands as above, but replace `stac-node-validator` with `node bin/cli.js`, for example `node bin/cli.js /path/to/your/file.json`
4. Run the commands as above, but replace `stac-node-validator` with `node bin/cli.js`, for example `node bin/cli.js /path/to/your/file.json`

### Test

Simply run `npm test` in a working [development environment](#development).

If you want to disable tests for your fork of the repository, simply delete `.github/workflows/test.yaml`.

0 comments on commit ecd5a75

Please sign in to comment.