summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authortranch <tranch.xiao@gmail.com>2026-08-26 10:59:21 +0800
committertranch <tranch.xiao@gmail.com>2026-08-26 10:59:21 +0800
commit10411b5e32b78f57b6ad995c434cfc4fc390d689 (patch)
tree431b9a7556ebe191314e34ed20bc7a507bfdbd42 /README.md
parentc7a47b2ba1cfc17348e729c1b7a6689bd5c9c95d (diff)
downloadAeroCore-OS-10411b5e32b78f57b6ad995c434cfc4fc390d689.tar.gz
AeroCore-OS-10411b5e32b78f57b6ad995c434cfc4fc390d689.zip
fix(config): make local dotenv optional
Load a private .env when present, but keep CI configuration in GitHub runtime variables and retain the tracked template as a guide.
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/README.md b/README.md
index 213e029..ac56ad9 100644
--- a/README.md
+++ b/README.md
@@ -41,13 +41,19 @@ with `INSTRUMENTS_RELEASE_REPOSITORY` and `INSTRUMENTS_RELEASE_API_BASE`.
## Local Build
-To build AeroCore OS locally, edit `image-template.env` to match your target configurations and then run:
+To build AeroCore OS locally, you may create a private `.env` from the
+committed template and edit it to match your target configuration:
```bash
-sudo just build
-
+cp image-template.env .env
+# edit .env
```
+`.env` is ignored by Git and optional. When it is absent, Just reads the
+required values from the runtime environment. Variables supplied by the shell
+or CI environment override matching values in `.env`, so you can test a
+different upstream base without changing files.
+
To test a different upstream base image directly without modifying the environment files:
```bash