From b07ca0c63b68c9d388d5d161f7eca5b0bfbc0f88 Mon Sep 17 00:00:00 2001 From: BigfootACA Date: Mon, 20 May 2024 09:57:03 +0800 Subject: [PATCH] add README.md Signed-off-by: BigfootACA --- README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..2678ff8 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# arch-image-builder + +A tool to build flashable and bootable image for Arch Linux + +## Install requirements + +Currently only support Arch based distros + +### Arch Linux + +Install required packages + +```commandline +pacman -S rsync pyalpm python-yaml python-libarchive-c +``` + +For cross build (UNTESTED) + +```commandline +pacman -S qemu-user-static-binfmt +``` + +## Example + +```commandline +python build.py -c target/ayn-odin2-sdcard,locale/zh-cn,desktop/gnome +``` + +## Options + +| Option | Description | +|-------------------------------------|---------------------------| +| -c CONFIG, --config CONFIG | Select configs to build | +| -o WORKSPACE, --workspace WORKSPACE | Set workspace for builder | +| -d, --debug | Enable debug logging | +| -G, --no-gpgcheck | Disable GPG check | +| -r, --repack | Repack rootfs only | + +## License + +SPDX: GPL-3.0-or-later