Skip to content

Commit 3724cbd

Browse files
committed
Update HTML output documentatioon
1 parent 31c74b2 commit 3724cbd

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

docs/user-guide/inspecting.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
11
# Inspecting results
22

3-
## g2html
3+
## HTML
4+
1. Run Goblint with additional `--html` argument.
5+
2. Run `python3 -m http.server --directory result 8080`
6+
or `npx http-server -c-1 result`.
7+
3. Inspect results at <http://localhost:8080/index.xml>.
8+
9+
Modern browsers' security settings forbid some file access which is necessary for the HTML output to work, hence the need for serving the results via Python's `http.server` (or similar).
10+
11+
## g2html (legacy)
12+
If there are problems with the above HTML output, the legacy g2html output (using an external Java component) is still possible.
13+
The frontend of the above HTML output is reused from g2html, so the two look the same (except for code highlighting).
14+
415
1. First time run: `make jar`.
5-
2. Run Goblint with additional `--html` argument.
16+
2. Run Goblint with additional `--set result g2html` arguments.
617
3. Run `python3 -m http.server --directory result 8080`
7-
or `npx http-server -c-1 result`.
18+
or `npx http-server -c-1 result`.
819
4. Inspect results at <http://localhost:8080/index.xml>.
920

1021
Modern browsers' security settings forbid some file access which is necessary for g2html to work, hence the need for serving the results via Python's `http.server` (or similar).

0 commit comments

Comments
 (0)