Skip to content

Commit 92b3231

Browse files
authored
Merge pull request #1852 from w3c/egekorkan-patch-3
Update README with rendering instructions
2 parents 8e89d4e + 658dc48 commit 92b3231

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -39,39 +39,38 @@ This repository covers the W3C Web of Things Thing Description family of specifi
3939
* [branch](https://github.com/w3c/wot-thing-description/tree/wot-td-1.0) - Branch that correspond to the Thing Description 1.0 files
4040
* [errata](https://w3c.github.io/wot-thing-description/errata.html) - Errata for version 1.0
4141

42-
43-
4442
## Specification Rendering
4543

4644
Part of the document is automatically rendered using the [STTL.js](https://github.com/vcharpenay/STTL.js/) RDF template engine and Node.js.
4745
_Any change to the document must be performed on the main HTML template [`index.template.html`](index.template.html)_, and not on `index.html`.
4846
To render `index.html`, along with SVG figures, run:
4947

50-
```sh
51-
npm run render
52-
```
48+
- `npm install` to install all the dependencies
49+
- `npm run render` to render all the files
5350

5451
You can also invoke the rendering script directly:
52+
5553
```sh
5654
./render.sh
5755
```
5856

59-
Requirements: Java 8, Node.js 6, [GraphViz](https://graphviz.org/).
57+
Requirements: Node.js 16, [GraphViz](https://graphviz.org/).
6058

6159
The script will first download and install some dependencies (triple store, Node.js dependencies) and then execute the JS script `render.js`.
62-
The latter should always be execute within `render.sh` since it requires some env variables to be set first.
60+
The latter should always be executed within `render.sh` since it requires some env variables to be set first.
6361

6462
For Windows users, the script should be run in a [Cygwin shell](http://cygwin.com/). Git package from Cygwin distribution had better not be used. Alternative Git client distribution such as [Git for Windows](https://gitforwindows.org/) works better when you encounter an issue building the document using Cygwin.
6563

6664
### Automatic rendering
67-
The repository is equipped with git hooks that automate the rendering process. To enable them, run `npm install` at the root folder. The hooks will render the documents automatically at every commit.
68-
if you run the rending process manually or you do not want to execute the automatic process add `--no-verify` option to your commit command.
65+
The repository is equipped with git hooks that automate the rendering process. To enable them, run `npm install` in the root folder. The hooks will render the documents automatically at every commit.
66+
If you run the rending process manually or you do not want to execute the automatic process add `--no-verify` option to your commit command.
6967

7068
## Implementation Report
7169

7270
To generate the implementation report,
7371
including a list of normative assertions,
7472
issue the following command:
73+
7574
```sh
7675
npm run assertions
7776
```

0 commit comments

Comments
 (0)