Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
mahdanoura committed Sep 16, 2024
1 parent 9844492 commit c5823dd
Showing 1 changed file with 18 additions and 17 deletions.
35 changes: 18 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,38 +19,39 @@ Step 2: Generate the final WoT TD specification document using the generated WoT
<img title="WoT Toolchain Overview" src="images/toolchain.svg">

## Prerequisites
Ensure you have Python 3.11 or greater installed.

The [uv](https://docs.astral.sh/uv/) package manager.
The [uv](https://docs.astral.sh/uv/) package manager is required.

## Quick Start
1. Clone the repository and navigate to the project directory:
```
git clone https://github.com/w3c/wot-thing-description-toolchain-tmp.git
cd wot-thing-description-toolchain-tmp
```
2. Run the script using `uv`
```
uv run main.py -h
```
2. Install the package
`uv install`

## Usage
The main.py script supports various options:
See the list of all WOTIS commands:
`wotis --help`

Generate WoT resources (RDF, JSON-LD Context, SHACL Shapes, and JSON Schema) from a default LinkML schema:
```
uv run main.py [-h] [-l] [-s]
wotis generate-wot-resources [-i] [-d] [-s] [--help]
options:
-h, --help show this help message and exit
-l, --local-docs Boolean for local documentation generation.
-s, --serve-docs Boolean for serving the generated documentation.
```
## Examples
Generate resources using the default schema and configuration:
```
uv run main.py
-i, --input_schema Path to the input schema specified as LinkML yaml.
[default: resources/schemas/thing_description.yaml]
-d, --generate_docs Boolean for local documentation generation.
-s, --serve_docs Boolean for serving the generated documentation.
--help Show this help message and exit.
```

Generate documentation locally and serve it:
`uv run main.py -l -s`
## Examples
Generate documentation using the default schema locally and serve it:
`wotis generate-wot-resources -l -s`

#### Default Paths
* LinkML schema: `resources/schemas/thing_description.yaml`
Expand Down

0 comments on commit c5823dd

Please sign in to comment.