Update: works with 3.0.5-1 now.
[pkg-games/live-games-image.git] / README
1 What is this?
2 -------------
3 This is a Debian Games live image configuration that will build a Wheezy amd64
4 image suitable for use on a 4G USB key or DVD.
5
6 Status
7 ------
8 As of the date of writing, it is tested against live-build 3.0.5-1.
9
10 Building the image
11 ------------------
12 * Ensure you have sufficient bandwidth to your preferred Debian archive
13   mirror to build the image, as it will be downloading a considerable
14   number of packages.
15 * Ensure you have enough disk space to build the image. About 5 times the
16   size of the final image is required, or about 20G for a 4G image.
17 * Ensure that the user building the image has superuser access via sudo.
18 * Ensure live-build is at least at the version indicated above, and download
19   any additional packages to the specified location if needed.
20 * Build the image:
21
22 $ make
23
24 * Some time later (how long depends on bandwidth, speed of disks, processor
25   etc.) an image file binary-hybrid.iso will be generated to the current
26   directory, along with a log of the process in build.log.
27 * The image is ready for use either on a USB key (via dd) or DVD (via wodim)
28   * For USB, copy it to the device node, not a partition node, e.g. /dev/sdx,
29     *not* /dev/sdx1:
30
31 $ cp binary-hybrid.iso /dev/sdx
32
33   * For DVD, use wodim to write to DVD-R(W) medium:
34
35 $ wodim binary-hybrid.iso
36
37 Making changes to the configuration
38 -----------------------------------
39 * You can change the configuration of the image in Makefile and/or
40   the config/ directory tree. See http://live.debian.net/manual for
41   details.
42 * If you make a major change that would invalidate the cache (e.g.
43   --distribution or --architecture) you should 'sudo lb clean --purge'
44   to throw away the cache before building with the new configuration.
45 * If your changes are suitable for the official image, please discuss
46   with the Debian Games Team <debian-devel-games@lists.debian.org> or
47   irc://debian-games@irc.oftc.net.
48
49 README author(s)
50 ----------------
51 Ben Armstrong <synrg@debian.org>