Skip to content

Commit 742417b

Browse files
committed
Finish off #625
1 parent c323f5c commit 742417b

File tree

2 files changed

+22
-3
lines changed

2 files changed

+22
-3
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,28 @@ See the [contributing page](http://jsonnet.org/contributing.html) on our website
8181

8282
### Running tests
8383

84-
TODO
84+
To run the comprehensive suite:
85+
86+
```
87+
make test
88+
```
8589

8690

8791
### Locally serving the website
8892

89-
TODO
93+
First, you need to build the JavaScript version of Jsonnet (which requires
94+
[_emscripten_](https://emscripten.org/)):
95+
96+
```
97+
make doc/js/libjsonnet.js
98+
```
99+
100+
Then, from the root of the repository you can generate and serve the website using
101+
[Jekyll](https://jekyllrb.com/):
102+
103+
```
104+
tools/scripts/serve_docs.sh
105+
```
106+
107+
This should the website on localhost:8080, automatically rebuild when you change any underlying
108+
files, and automatically refresh your browser when that happens.

tools/scripts/serve_docs.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ exit 1
3131
fi
3232

3333
cd doc
34-
jekyll server --port 8200 --watch
34+
jekyll server --port 8200 --watch --livereload

0 commit comments

Comments
 (0)