summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2023-09-02 12:04:32 +0000
committerLars Wirzenius <liw@liw.fi>2023-09-02 12:04:32 +0000
commitef57300c04f63251a8440f8c85c8805944a2130c (patch)
tree189278a146af1eef61b0371ee77954b29b2961bc
parent0f224073900e0c36772d0b7fc52bf5110e1cfcfb (diff)
parent2a20230876bb4090913afe44ff8985a948f9494f (diff)
downloadv-i-ef57300c04f63251a8440f8c85c8805944a2130c.tar.gz
Merge branch 'liw/build-installer-doc' into 'main'
docs(README.md): add instructions for building the installer image See merge request larswirzenius/v-i!58
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
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