Skip to content

Commit 6f3901e

Browse files
authored
Extend README with an instruction for the local setup (#253)
1 parent a5ec68d commit 6f3901e

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,31 @@ WebDriver BiDi is not ready. Here's what we have so far:
77
- An [explainer](./explainer.md) with more background and goals
88
- Detailed [proposals](./proposals/) for the initial protocol
99
- A [unofficial spec draft](https://w3c.github.io/webdriver-bidi/) waiting to be fleshed out
10+
11+
12+
## How to build the specification locally
13+
14+
We use [bikeshed](https://tabatkins.github.io/bikeshed/) to generate the specification.
15+
16+
Make sure you have the [right version of python](https://tabatkins.github.io/bikeshed/#install-py3) installed.
17+
18+
Now you can run in your terminal:
19+
```
20+
./scripts/build.sh --install
21+
```
22+
This script will install `bikeshed` and generate an `index.html` file for the specification.
23+
24+
Later on, you can omit `--install` argument to skip the installation step.
25+
26+
## How to generate CDDL locally
27+
28+
Make sure you have [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
29+
and [rust](https://www.rust-lang.org/tools/install) installed.
30+
31+
Now you can run in your terminal:
32+
```
33+
./scripts/test.sh --install
34+
```
35+
This script will install required npm and cargo packages and generate CDDL.
36+
37+
Later on, you can omit `--install` argument to skip the installation step.

0 commit comments

Comments
 (0)