From 5fd6c5d9fff97aba36347456a808787b8325af1c Mon Sep 17 00:00:00 2001 From: x0rw Date: Tue, 29 Apr 2025 15:53:19 +0100 Subject: [PATCH 1/2] Update readme.md with offline building section --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 40f6b61..175d0d5 100644 --- a/README.md +++ b/README.md @@ -37,9 +37,23 @@ A machine-parseable artifact will be available at `build/html/needs.json`. (ToDo 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. + +## Running builds offline + +If you're working without internet access or want to avoid reaching out to remote resources (e.g., fetching updated specs), you can pass the --offline flag: + +```shell + ./make.py --offline +``` + +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. + +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. + + ## Build breaking due to out-dated spec lock file -It's a fairly common occurence for the build to break due to an out of date spec lock file, located at: +It's a fairly common occurrence for the build to break due to an out of date spec lock file, located at: ``` src/spec.lock From 7db528f0e92b6100cc91a51bdff12920ebb646fb Mon Sep 17 00:00:00 2001 From: x0rw Date: Tue, 29 Apr 2025 16:00:26 +0100 Subject: [PATCH 2/2] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 175d0d5..acf734a 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ A record with checksums of the contents is available at `build/html/guidelines-i ## Running builds offline -If you're working without internet access or want to avoid reaching out to remote resources (e.g., fetching updated specs), you can pass the --offline flag: +If you're working without internet access or want to avoid reaching out to remote resources, you can pass the `--offline` flag: ```shell ./make.py --offline @@ -48,7 +48,7 @@ If you're working without internet access or want to avoid reaching out to remot 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. -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. +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. ## Build breaking due to out-dated spec lock file