initial source tree import
[tails-test.git] / config / chroot_local-includes / usr / share / doc / amnesia / README
blob79a79df3e980010824b01b42034caca1faf9f3b0
1 -*- mode: markdown; -*-
3 Building an image
4 =================
6 Customization
7 -------------
9 The settings that can be customized can be found in `config/amnesia`;
10 e.g. images types to build, desktop environment.
12 You'd better never directly edit this file: rather put your custom
13 variable assignments in a new `config/amnesia.local` file. The values
14 found in the `.local` file will override the ones from the
15 upstream one.
17 These configuration files are actually shell scripts, and are sourced
18 by various other scripts.
20 How to build
21 ------------
23 All following commands must be run as `root`, at the root of the
24 source directory: a Git checkout, an extracted tarball.
26 Initialize the Live system's configuration with `lh_config`:
28         lh_config
30 Optionally set your preferred language for the generated images; only
31 "fr" is currently fully supported, but other languages are still worth
32 trying:
34         lh_config --language fr
36 You can then use the standard live-helper commands to build the chosen
37 images (`lh build`) and to cleanup the build directory (`lh clean`).