Skip to content

Commit 16e64a1

Browse files
authored
Add instructions for offline builds to README.md (#57)
* Update readme.md with offline building section * Update README.md
1 parent 3f3d338 commit 16e64a1

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,23 @@ A machine-parseable artifact will be available at `build/html/needs.json`. (ToDo
3737

3838
A record with checksums of the contents is available at `build/html/guidelines-ids.json`. Users of the coding guidelines can reference this file to determine if there have been changes to coding guidelines contents they should be aware of.
3939

40+
41+
## Running builds offline
42+
43+
If you're working without internet access or want to avoid reaching out to remote resources, you can pass the `--offline` flag:
44+
45+
```shell
46+
./make.py --offline
47+
```
48+
49+
This prevents the build system from attempting to fetch remote resources, such as updates to the specification. Use this flag when you need reproducible or air-gapped builds.
50+
51+
It is recommended to use `--offline` if you are running `make.py` frequently during development. The builder fetches data from [the Ferrocene Language Specification website](https://spec.ferrocene.dev/paragraph-ids.json), which may rate-limit repeated requests—leading to delays or failed builds. Using `--offline` can significantly improve build speed and avoid unnecessary network issues during iterative work.
52+
53+
4054
## Build breaking due to out-dated spec lock file
4155

42-
It's a fairly common occurence for the build to break due to an out of date spec lock file, located at:
56+
It's a fairly common occurrence for the build to break due to an out of date spec lock file, located at:
4357

4458
```
4559
src/spec.lock

0 commit comments

Comments
 (0)