README: Program name does not need /usr/bin path.
[a-fedora-appliance.git] / README
1 This is a package that contains a Fedora appliance, otherwise known as
2 a small Fedora virtual machine.
3
4 ----------------------------------------------------------------------
5 (1) If you have just installed this package from an RPM
6 ----------------------------------------------------------------------
7
8 The appliance is located in /var/lib/a-fedora-appliance/
9
10 There are three files:
11   - kernel: symbolic link to the kernel
12   - initrd: initrd
13   - root: the appliance disk itself
14
15 To test boot the appliance, run:
16   sudo boot-a-fedora-appliance
17
18 You probably want to copy /usr/bin/boot-a-fedora-appliance and modify
19 it for your own purposes.
20
21
22 ----------------------------------------------------------------------
23 (2) If you are building from the source tarball
24 ----------------------------------------------------------------------
25
26 'supermin' version 5 or above is required:
27 http://people.redhat.com/~rjones/supermin/
28
29 Do:
30
31   ./configure
32   make
33
34 To run locally without installing:
35
36   make local-build
37
38 This creates 3 files (kernel, initrd, root) under appliance.d/
39
40 You can test-boot this appliance by doing:
41
42   make local-boot
43
44
45 ----------------------------------------------------------------------
46 (3) If you want to do a Koji scratch build
47 ----------------------------------------------------------------------
48
49 Do:
50
51   ./configure
52   make
53   make dist
54
55   make koji-f20