churn/README.md

1.4 KiB

Butter Churn

License

Tool for building Butter Box disk images.

Host prerequisites

The build host needs vmdb2 and, for the amd64 image, the syslinux-common package — the amd64 recipe writes GPT protective-MBR boot code (/usr/lib/syslinux/mbr/gptmbr.bin) directly to the output image from the host filesystem, so this package must be present on the build machine (not just inside the target image):

sudo apt install syslinux-common

Usage

To build a butter image, run:

vmdb2 --rootfs-tarball=my_image.tar.gz --output my_image.img --log my_image.log

Advanced Documentation

© 2017, Michael Stapelberg and contributors
© 2021, guardianproject
© 2025-2026, SR2 Communications Limited

See LICENCE for details of the BSD-3 clause licence.

This project is a derivative work of: