Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cstirdivant authored Nov 21, 2023
1 parent 4bf6eee commit 259f4a3
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions tools/validators/ontology_validator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ The validator is Python-based and takes the following parameters:
* `--modified-ontology-types` or `-m` **[Optional]**: An absolute or relative path to the modified files of the ontology.
* `--interactive` or `-i` **[Optional]**: Enables interactive mode.

The validator can be run as follows: `python3 validator.py -o Users/foo/ontology/` or `python3 validator.py --original Users/foo/ontology/`
The validator can be run as follows: `python3 validator.py -o=Users/foo/ontology/` or `python3 validator.py --original=Users/foo/ontology/`

### Ontology Types Extended

If you have extended the ontology by adding new types to your local ontology, run the following: `python3 validator.py --original Users/foo/ontology/ --modified-ontology-types path/to/modified/ontology/types/folder`
If you have extended the ontology by adding new types to your local ontology, run the following: `python3 validator.py --original=Users/foo/ontology/ --modified-ontology-types=path/to/modified/ontology/types/folder`

When using a modified ontology, ensure you follow the folder-naming convention: `digitalbuildings/ontology/yaml`.

Expand Down

0 comments on commit 259f4a3

Please sign in to comment.