From 2a20230876bb4090913afe44ff8985a948f9494f Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Sat, 2 Sep 2023 14:13:48 +0300 Subject: docs(README.md): add instructions for building the installer image Sponsored-by: author --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 58537ad..1cb82b3 100644 --- a/README.md +++ b/README.md @@ -227,7 +227,20 @@ the installer. If you have a working installer image, you can update those two files by copying new versions into place: this is much faster than building a whole new installer image. +## Building the installer image +To build the installer image, run the following on a Debian system +with the required dependencies installed and access to the Internet: + +~~~sh +sudo ./build-installer.sh ~/installer.tar.gz +~~~ + +The file name argument, `~/installer.tar.gz`, specifies what file to +use to cache the output of `debootstrap` between runs of the script. +The cache is created if it doesn't exist, and is used to speed up +repeated builds significantly. You need to use different cache if you +change the `deboottrap` or `apt` steps in the `installer.vmdb` file. ## FAQ -- cgit v1.2.1