From ba24a361a12bd78f3277ad047d2b8167dff4adf9 Mon Sep 17 00:00:00 2001 From: Sakars Date: Wed, 1 Jan 2025 16:44:51 +0000 Subject: [PATCH] readme update --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 79f93e5..eeeb2ac 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ # JSOG [![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) + +This is a tool for generating C++ files from JSON Schemas. + +## Usage +`JSOG [options] ` + +## Options +- `--help`: Display help message. +- `-h`: Alias for `--help`. +- `--output-directory `: Output directory for generated files. Default is current directory. +- `-o`: Alias for `--output-directory`. +- `--dump-schemas`: Logs intermediate representation of schemas +for debugging purposes. +- `-d`: Alias for `--dump-schemas`. +- `--require `: Adds a JSON Schema URI to the list of required schemas. +- `-r`: Alias for `--require`. +- `--preferred-identifier `: Sets the preferred identifier for a schema. +- `-p`: Alias for `--preferred-identifier`. +