Skip to content

Commit 9cd321c

Browse files
authored
Merge pull request #7 from sakars/readme-update
readme update
2 parents d4283a2 + ba24a36 commit 9cd321c

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,21 @@
11
# JSOG
22
[![Build and Test](https://github.com/sakars/JSOG/actions/workflows/cmake-single-platform.yml/badge.svg)](https://github.com/sakars/JSOG/actions/workflows/cmake-single-platform.yml)
3+
4+
This is a tool for generating C++ files from JSON Schemas.
5+
6+
## Usage
7+
`JSOG [options] <schema files>`
8+
9+
## Options
10+
- `--help`: Display help message.
11+
- `-h`: Alias for `--help`.
12+
- `--output-directory <path>`: Output directory for generated files. Default is current directory.
13+
- `-o`: Alias for `--output-directory`.
14+
- `--dump-schemas`: Logs intermediate representation of schemas
15+
for debugging purposes.
16+
- `-d`: Alias for `--dump-schemas`.
17+
- `--require <uri>`: Adds a JSON Schema URI to the list of required schemas.
18+
- `-r`: Alias for `--require`.
19+
- `--preferred-identifier <uri> <identifier>`: Sets the preferred identifier for a schema.
20+
- `-p`: Alias for `--preferred-identifier`.
21+

0 commit comments

Comments
 (0)