From 422d8980336a4638739a7286e15c059243c77cc2 Mon Sep 17 00:00:00 2001 From: Kros Dai Date: Sat, 26 Sep 2026 17:49:09 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs(iso):=20explain=20regional?= =?UTF-8?q?=20build=20requirements?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - :memo: explain matching runtime sources and optional regional bootstrap - :warning: disclose rolling-mirror compatibility and acceptance requirements Amp-Thread-ID: T-01a0df38-0ea7-759b-bcff-29da223cc567 --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 1ec23ea..ecc47b5 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,20 @@ Despite the local folder name, the first argument is the Omarchy source checkout Use `--dev` or `--rc` to build against those package channels. Both `--dev` and `--edge` select the dev packages from the edge mirror. +### Regional builds + +`--region cn` adds China bootstrap defaults independently of the channel. The default, `--region global`, preserves the existing package set, mirrors, cache paths, and artifact names. Supported country profiles use lowercase ISO 3166-1 alpha-2 codes; currently only `cn` is implemented. + +For an unpublished regional runtime, use matching local source and package-recipe checkouts: + +```bash +./bin/omarchy-iso-make --region cn --no-boot-offer --local-source /path/to/omarchy /path/to/omarchy-pkgs +``` + +China builds keep the channel mirror first, append the USTC Arch mirror, and add ArchLinuxCN with its verified keyring. USTC is rolling, not a matching stable/RC snapshot; fallback version compatibility is not guaranteed. The runtime profile also bundles offline Simplified Chinese Pinyin using the existing Fcitx5 service, with `Alt+Space` to switch input. New-user defaults are staged before user creation, including deferred setup, without changing existing homes, language, timezone, or keyboard settings. Users can change these defaults after installation; see `docs/regions.md` in the companion runtime checkout. + +Non-global cache and ISO names gain a `-cn` suffix. A runtime without the selected profile fails the build. These builds require an x86_64 Arch container environment; packaging and input checks on another architecture do not substitute for a fresh build, offline installation, and graphical acceptance run. + ## Autoinstall The shipped ISO installs itself with no keyboard when it finds its configuration on a second drive. Attach a drive labeled `cidata` alongside the ISO and the installer copies the config off it and skips the configurator; with no such drive, nothing changes and the wizard runs as usual. No rebuild, no extra boot entry.