Add TODO file.
[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   gawk
36
37   libcom_err
38   libext2fs
39   /sbin/mke2fs
40     - These are part of e2fsprogs.
41
42 For Fedora/RHEL:
43
44   rpm
45   yum
46   yumdownloader
47
48 For Debian/Ubuntu:
49
50   dpkg
51   aptitude
52
53 Optional
54 --------
55
56 These are only needed if you plan to boot the supermin appliances you
57 are building:
58
59   qemu >= 0.13
60   kernel >= 2.6.36
61
62   zlib - if your kernel uses gzipped modules
63
64 Building and installing
65 -----------------------
66
67   ./configure
68   make
69   sudo make install
70
71 Feedback and bugs
72 -----------------
73
74 Send feedback to libguestfs@redhat.com.  You can file bugs in
75 https://bugzilla.redhat.com/ (under "Fedora", "febootstrap")
76