Skip to content

Commit 3f3d338

Browse files
espenalbPLeVasseur
andauthored
Document how to build on Windows. (#56)
* Document how to build on Windows. resolves #47 * Minor formatting nit * Minor formatting nit to match surrounding commands --------- Co-authored-by: Pete LeVasseur <[email protected]>
1 parent 413cb79 commit 3f3d338

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,18 @@ The Safety-Critical Rust Coding Guidelines use `Sphinx` and `Sphinx-Needs` to bu
1010

1111
You can build the rendered version by running:
1212

13+
On Linux-like systems:
14+
1315
```shell
1416
./make.py
1517
```
1618

19+
On Windows systems:
20+
21+
```shell
22+
uv run make.py
23+
```
24+
1725
By default, Sphinx uses incremental rebuilds to generate the content that
1826
changed since the last invocation. If you notice a problem with incremental
1927
rebuilds, you can pass the `-c` flag to clear the existing artifacts before

0 commit comments

Comments
 (0)