docs: Note that gawk (GNU awk) is required.
[febootstrap.git] / README
1 febootstrap - Bootstrapping tool for creating supermin appliances
2 by Richard W.M. Jones (rjones@redhat.com)
3 http://people.redhat.com/~rjones/febootstrap
4 ----------------------------------------------------------------------
5
6 febootstrap is a tool for building supermin appliances.  These are
7 tiny appliances [similar to virtual machines], usually around 100KB in
8 size, which get fully instantiated on-the-fly in a fraction of a
9 second when you need to boot one of them.
10
11 A complete description is in the febootstrap(8) man page.
12
13 IMPORTANT NOTE FOR USERS OF FEBOOTSTRAP 2.x:
14   febootstrap 3.x is a complete rewrite.  febootstrap 2.x could only
15   build Fedora distributions.  This version can build many varieties
16   of Linux distros.  3.x only builds supermin appliances, it does not
17   build chroots.  3.x does not build cross-distro, cross-release or
18   cross-architecture systems.  If you want febootstrap 2.x, please use
19   the 'febootstrap-2.x' branch from the git repository.
20
21 Requirements
22 ------------
23
24   ocaml
25
26   ocaml findlib ("ocamlfind" program)
27
28   perldoc
29     - This is just used to generate the manpage.
30
31   bash
32
33   gcc
34
35   qemu
36     - Only if you need to test-boot appliances.
37
38   gawk
39
40   libcom_err
41   libext2fs
42   /sbin/mke2fs
43     - These are part of e2fsprogs.
44
45   /sbin/insmod.static
46     - This is part of module-init-tools.  Note that Debian does NOT
47       package this, you have to build it yourself (or copy the file
48       from a Fedora machine which also works ...)
49
50 Optional
51 --------
52 (but you will need a package manager for your Linux distro)
53
54   yum
55   rpm
56   apt-get
57   dpkg
58
59 Building and installing
60 -----------------------
61
62   ./configure
63   make
64   sudo make install
65
66 Feedback and bugs
67 -----------------
68
69 Send feedback to libguestfs@redhat.com.  You can file bugs in
70 https://bugzilla.redhat.com/ (under "Fedora", "febootstrap")
71