RomanNum3ral
/
quickemu
mirror of https://github.com/quickemu-project/quickemu.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: update documentation 

Signed-off-by: Martin Wimpress <martin@wimpress.org>
This commit is contained in:
Martin Wimpress 2026-01-25 02:22:38 +00:00
parent 0742312aa5
commit d8b27e8480
No known key found for this signature in database
2 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
AGENTS.md
View File

@ -27,6 +27,8 @@ The devshell patches `quickemu` to use Nix store paths for OVMF and Samba, writi
- Lint scripts: `shellcheck quickemu quickget quickreport chunkcheck` - Lint scripts: `shellcheck quickemu quickget quickreport chunkcheck`
- Test quickget URLs: `./quickget --check <os> [release] [edition]` - Test quickget URLs: `./quickget --check <os> [release] [edition]`
- Test ARM64 downloads: `./quickget --arch arm64 --check <os> [release] [edition]`
- Test all architectures: `./quickget --check-all-arch <os> [release] [edition]`
- List all supported OSes: `./quickget --list` - List all supported OSes: `./quickget --list`
- Run VM: `./quickemu --vm <name>.conf` - Run VM: `./quickemu --vm <name>.conf`
@ -53,7 +55,8 @@ Follow the [guide in the wiki](https://github.com/quickemu-project/quickemu/wiki
1. Entry in `os_info()` case statement 1. Entry in `os_info()` case statement
2. `releases_<os>()` function returning available versions 2. `releases_<os>()` function returning available versions
3. `editions_<os>()` function if multiple editions exist 3. `editions_<os>()` function if multiple editions exist
4. Download URL construction logic 4. `arch_<os>()` function if ARM64 is supported (defaults to amd64 only if omitted)
5. Download URL construction logic
## Commit message format ## Commit message format
@ -96,10 +99,13 @@ fix(quickget): remove Athena OS (no longer getting updates)
## Platform support ## Platform support
- Host: Linux (x86_64, aarch64), macOS (x86_64, aarch64) - Host: Linux (x86_64, aarch64), macOS (x86_64, aarch64)
- Guest: x86_64 (default), aarch64 (set `arch="aarch64"` in VM config)
- ARM64 guests use AAVMF firmware and `virt` machine type
- Cross-arch emulation uses TCG (no KVM acceleration)
- OVMF/UEFI firmware: Linux only - OVMF/UEFI firmware: Linux only
- Bash 4.0+ required (explicit version check at runtime) - Bash 4.0+ required (explicit version check at runtime)
## Key dependencies ## Key dependencies
Runtime: qemu, cdrtools, curl, jq, spice-gtk, swtpm, samba, zsync Runtime: qemu, cdrtools, curl, jq, spice-gtk, swtpm, samba, zsync
Linux-specific: OVMF, usbutils, mesa-demos Linux-specific: OVMF (x86_64 guests), AAVMF (aarch64 guests), usbutils, mesa-demos

1
README.md
View File

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