docs: Note that libcom_err 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   libcom_err
39   libext2fs
40   /sbin/mke2fs
41     - These are part of e2fsprogs.
42
43 Optional
44 --------
45 (but you will need a package manager for your Linux distro)
46
47   yum
48   rpm
49   apt-get
50   dpkg
51
52 Building and installing
53 -----------------------
54
55   ./configure
56   make
57   sudo make install
58
59 Feedback and bugs
60 -----------------
61
62 Send feedback to libguestfs@redhat.com.  You can file bugs in
63 https://bugzilla.redhat.com/ (under "Fedora", "febootstrap")
64