Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mahdanoura authored May 21, 2024
1 parent 5d07154 commit f26943a
Showing 1 changed file with 32 additions and 10 deletions.
42 changes: 32 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,38 @@
# Temporary WoT TD Tooling

This repository is a LinkML-based schema for modelling the [Web of Things Thing Description](https://www.w3.org/TR/wot-thing-description11/) information model.
The aim is simplify the current WoT specification generation process.
For more information please refer to the [WoT github repo](https://github.com/w3c/wot-thing-description/tree/main/toolchain).
The aim of this repository is to simplify the current WoT TD tooling for generating the specification. WoT TD Tooling is a python project to automate the generation of
1) WoT resources (SHACL Shapes, jsonschema, JSON-LD context, and ontology files)
2) Documentation of specification (TD specification and ontology specification)

This project uses [LinkML](https://linkml.io/linkml/) for modelling the [Web of Things Thing Description](https://www.w3.org/TR/wot-thing-description11/) information model.
For more information on the current process of the WoT TD tooling please refer to the [WoT github repo](https://github.com/w3c/wot-thing-description/tree/main/toolchain).

## Prerequisites

[Make](https://www.gnu.org/software/make)
[Poetry](https://python-poetry.org)

## Quick Start

### 1. Install Dependencies

First, install the necessary dependencies using `poetry`:

```bash
make install

### 2. Generate WoT resources
```bash
make setup
Run the initial setup to generate project files and examples:
1. Ensure you have Make installed [Make](https://www.gnu.org/software/make)
* Install Python 3 (try to upgrade your version if the following steps do not work)
* Install [Poetry](https://python-poetry.org/)
* Run `poetry install` to install dependencies
* Run `make all` create all resources
* When ready, run `make test` to validate the LinkML schema, based on the test data found in `examples` folder
*
## Repository Structure
* [examples/](examples/) - example data
Expand All @@ -15,11 +44,4 @@ For more information please refer to the [WoT github repo](https://github.com/w3
Python datamodel
* [tests/](tests/) - Python tests
## Developer Documentation
* Install [Make](https://www.gnu.org/software/make)
* Install Python 3 (try to upgrade your version if the following steps do not work)
* Install [Poetry](https://python-poetry.org/)
* Run `poetry install` to install dependencies
* Run `make all` create all resources
* When ready, run `make test` to validate the LinkML schema, based on the test data found in `examples` folder

0 comments on commit f26943a

Please sign in to comment.