README
1Tool to publish board-status data to the website
2================================================
3
4This tool parses the board-status repository (and the coreboot repository as
5companion) to build a meaningful representation of the test coverage stored
6in board-status.
7
8The server runs these regularly to update
9https://coreboot.org/status/board-status.html
10
11How to use
12----------
13When modifying the tool, or when publishing the results elsewhere, you
14might want to run it yourself. You'll need the board-status and the coreboot
15repository checked out.
16
17To build the tool, run the following commands
18
19 $ go mod download
20 $ go build
21
22To run it, use
23
24 $ ./board-status.html \
25 -board-status-dir .../board-status.git \
26 -coreboot-dir .../coreboot.git > out.html
27
28There will be a few errors about missing revisions, those come from status
29reports based on unpublished commits.
30
31LIMITATIONS
32-----------
33The tool doesn't support board variants or "clone of" specifiers in
34board-info.txt. The output is also a bit unwieldy, leading to many megabytes
35of HTML in a single file.
36