Skip to content

Commit 70d3fd4

Browse files
committed
Updated readme-dev to reflect the changes in how the web site (and themed documentation) can be rendered locally.
1 parent 0e4a0b1 commit 70d3fd4

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

README-dev.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,19 +45,26 @@ automatically:
4545
```
4646

4747
Make sure that `build.sh` is called from the main directory. The output will
48-
be in `web-build`. You are likely going to need to load it through a web
49-
server. A simple way to do so is:
48+
be in `web-build`.
49+
50+
3. Render the web site and themed documentation, which can be done using Jekyll.
51+
To install Jekyll, follow these
52+
[instructions](https://jekyllrb.com/docs/installation/). Then run
5053

5154
```
52-
cd web-build
53-
python -m http.server <port>
55+
web/serve.sh
5456
```
5557

56-
where `<port>` is a port number to start the HTTP server on.
58+
which will output something like this:
59+
```
60+
...
61+
Server address: http://127.0.0.1:4000/psij-python/
62+
Server running... press ctrl-c to stop.
63+
```
5764
58-
When developing the web site, a convenient script is `web/watch.sh`, which can
59-
monitor the source directories and re-build when files are modified. This
60-
requires `inotify` which may or may not be available on your platform.
65+
Pointing your web browser to the URL printed by Jekyll will show the PSI/J
66+
web site. The themed documentation will be found under the "Documentation"
67+
tab.
6168
6269
6370
### Release process

0 commit comments

Comments
 (0)