Skip to content

Commit d8b27e8

Browse files
committed
docs: update documentation
Signed-off-by: Martin Wimpress <martin@wimpress.org>
1 parent 0742312 commit d8b27e8

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

AGENTS.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ The devshell patches `quickemu` to use Nix store paths for OVMF and Samba, writi
2727

2828
- Lint scripts: `shellcheck quickemu quickget quickreport chunkcheck`
2929
- Test quickget URLs: `./quickget --check <os> [release] [edition]`
30+
- Test ARM64 downloads: `./quickget --arch arm64 --check <os> [release] [edition]`
31+
- Test all architectures: `./quickget --check-all-arch <os> [release] [edition]`
3032
- List all supported OSes: `./quickget --list`
3133
- Run VM: `./quickemu --vm <name>.conf`
3234

@@ -53,7 +55,8 @@ Follow the [guide in the wiki](https://github.com/quickemu-project/quickemu/wiki
5355
1. Entry in `os_info()` case statement
5456
2. `releases_<os>()` function returning available versions
5557
3. `editions_<os>()` function if multiple editions exist
56-
4. Download URL construction logic
58+
4. `arch_<os>()` function if ARM64 is supported (defaults to amd64 only if omitted)
59+
5. Download URL construction logic
5760

5861
## Commit message format
5962

@@ -96,10 +99,13 @@ fix(quickget): remove Athena OS (no longer getting updates)
9699
## Platform support
97100

98101
- Host: Linux (x86_64, aarch64), macOS (x86_64, aarch64)
102+
- Guest: x86_64 (default), aarch64 (set `arch="aarch64"` in VM config)
103+
- ARM64 guests use AAVMF firmware and `virt` machine type
104+
- Cross-arch emulation uses TCG (no KVM acceleration)
99105
- OVMF/UEFI firmware: Linux only
100106
- Bash 4.0+ required (explicit version check at runtime)
101107

102108
## Key dependencies
103109

104110
Runtime: qemu, cdrtools, curl, jq, spice-gtk, swtpm, samba, zsync
105-
Linux-specific: OVMF, usbutils, mesa-demos
111+
Linux-specific: OVMF (x86_64 guests), AAVMF (aarch64 guests), usbutils, mesa-demos

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ required to run the virtual machines.
4141
- **macOS** Sequoia, Sonoma, Ventura, Monterey, Big Sur, Catalina & Mojave
4242
- **Windows** 10 and 11 including TPM 2.0
4343
- **Windows Server** 2022 2019 2016
44+
- **ARM64 guest support** for running aarch64 VMs (native on ARM hosts, emulated on x86_64)
4445
- [Ubuntu](https://ubuntu.com/desktop) and all the **[official Ubuntu
4546
flavours](https://ubuntu.com/download/flavours)**
4647
- **Nearly 1000 operating system editions are supported!**

0 commit comments

Comments
 (0)