Skip to content

Commit

Permalink
Merge pull request #1871 from w3c/egekorkan-patch-1
Browse files Browse the repository at this point in the history
Small README fixes
  • Loading branch information
egekorkan authored Aug 23, 2023
2 parents 29fb025 + 3490e54 commit d84d8ad
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ General information about the Web of Things can be found on https://www.w3.org/W

---

Each commit here will sync it to the master, which will expose the content to http://w3c.github.io/wot-thing-description/.
Each commit here will sync to the master, which will expose the content to http://w3c.github.io/wot-thing-description/.

For the draft TD specification for TAG review, please access this [URL](https://cdn.staticaly.com/gh/w3c/wot-thing-description/TD-TAG-review/index.html?env=dev).

To make contributions, please provide pull-requests to the appropriate files,
To make contributions, please provide pull requests to the appropriate files,
keeping in mind that some files, most notably `index.html` and `testing/report.html`,
as well as most files under `visualization`, are
autogenerated and should not be modified directly.
Expand All @@ -29,14 +29,11 @@ This repository covers the W3C Web of Things Thing Description family of specifi
### Thing Description 1.1 (Maintenance)
* [Editor's Draft](http://w3c.github.io/wot-thing-description/) - Latest editor's draft of the Thing Description Maintenance version
* [Working Draft](https://www.w3.org/TR/wot-thing-description11/) - Latest working draft of the Thing Description Maintenance version
* [branch](https://github.com/w3c/wot-thing-description/) - Points to the master branch of this repo
* [issues](https://github.com/w3c/wot-thing-description/issues) - Points to the issues related to the Thing Description Maintenance version
* [feature log](https://github.com/w3c/wot-thing-description/blob/master/NEW_FEATURES.md) - Log of the new features of the Thing Description Maintenance version compared to Thing Description 1.0

* [branch](https://github.com/w3c/wot-thing-description/tree/main) - Points to the main branch of this repository

### Thing Description 1.0
* [REC](https://www.w3.org/TR/2020/REC-wot-thing-description-20200409/) - Official recommendation version of the Thing Description 1.0
* [branch](https://github.com/w3c/wot-thing-description/tree/wot-td-1.0) - Branch that correspond to the Thing Description 1.0 files
* [branch](https://github.com/w3c/wot-thing-description/tree/wot-td-1.0) - Branch that corresponds to the Thing Description 1.0 files
* [errata](https://w3c.github.io/wot-thing-description/errata.html) - Errata for version 1.0

## Specification Rendering
Expand All @@ -59,11 +56,12 @@ Requirements: Node.js 16, [GraphViz](https://graphviz.org/).
The script will first download and install some dependencies (triple store, Node.js dependencies) and then execute the JS script `render.js`.
The latter should always be executed within `render.sh` since it requires some env variables to be set first.

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.
For Windows users, the script should be run in a [Cygwin shell](http://cygwin.com/). The Git package from Cygwin distribution should 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.

### Automatic rendering

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.
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.
If you run the rending process manually or you do not want to execute the automatic process add the `--no-verify` option to your commit command.

## Implementation Report

Expand Down Expand Up @@ -96,7 +94,7 @@ be marked up as in the following examples and follow RFC2119 conventions:

The assertions must be marked up as follows:
* Enclose each assertion in a span.
* Mark the span with unique id.
* Mark the span with a unique id.
It is recommended that the section id be followed
by a short unique name for the specific assertion.
* Mark the span with a 'class' attribute set to `rfc2119-assertion`.
Expand Down

0 comments on commit d84d8ad

Please sign in to comment.