summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTranch <tranch.xiao@gmail.com>2026-08-26 11:20:16 +0800
committerGitHub <noreply@github.com>2026-08-26 11:20:16 +0800
commit65906b9536aaebdec4169b40e7b9eb86b73e65fe (patch)
tree56dfe91e98326a18363f1f4781cf001a6200e187 /README.md
parentc7a47b2ba1cfc17348e729c1b7a6689bd5c9c95d (diff)
parent890d6cd86b6bc83b7960c5f54a526af2c13cb755 (diff)
downloadAeroCore-OS-65906b9536aaebdec4169b40e7b9eb86b73e65fe.tar.gz
AeroCore-OS-65906b9536aaebdec4169b40e7b9eb86b73e65fe.zip
Merge pull request #21 from AeroCore-IO/fix/dotenv-overrides
fix(config): make local dotenv optional
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