X-Git-Url: https://git.grml.org/?p=grml-live.git;a=blobdiff_plain;f=docs%2Fgrml-live.txt;h=52b7d2d1937ecc56dd264a8db706aaf4027f429c;hp=8e859a4d08bf7a012476ab5fee606ea748dfff41;hb=18599825c2c04fab49b5b36f5da9404a88b5e0b2;hpb=f50966ae5939137aa7887a2c46753419d71f6ca6

diff --git a/docs/grml-live.txt b/docs/grml-live.txt
index 8e859a4..52b7d2d 100644
--- a/docs/grml-live.txt
+++ b/docs/grml-live.txt
@@ -3,33 +3,41 @@ grml-live(8)
 
 Name
 ----
-grml-live - build process script for generating a (grml based) Linux Live-ISO
+
+grml-live - build framework for generating a grml and Debian based Linux Live
+system (CD/ISO)
 
 Synopsis
 --------
+
 grml-live [-c <classe[s]>] [-t <target_directory>] [-F] [-h|--help]
 
 *******************************************************************************
 Important! grml-live is under heavy construction, though your feedback is highly
 appreciated.  This document is growing as requested. If you have questions which
-aren't answered by this document yet please let me (mika@grml.org) know!
+aren't answered by this document yet please let me know: <mika@grml.org>!
 *******************************************************************************
 
 Description
 -----------
 
-grml-live provides the build system for creating (a grml based) live-cd. The
-build system is based on link:http://www.informatik.uni-koeln.de/fai/[FAI]
-(Fully Automatic Installation).
+grml-live provides the build system for creating a grml and Debian based Linux
+live-cd. The build system is based on
+link:http://www.informatik.uni-koeln.de/fai/[FAI] (Fully Automatic
+Installation). grml-live uses the "fai dirinstall" feature to generate a chroot
+system based on the class concept of FAI (see later section for further details)
+and provides all the details to be able to generate a full-featured ISO. It does
+not use all the FAI features by default though and you don't have to know FAI to
+be able to use it.
 
-FAI uses a class based system. This gives you the flexibility to choose the
+The use of FAI behind the curtains gives you the flexibility to choose the
 packages you would like to include on your very own Linux live-cd without having
 to deal with all the details of a build process.
 
-CAUTION: grml-live does not use /etc/fai for configuration but instead provides
-and uses /etc/grml/fai. This ensures that it does not clash with default FAI
-configuration and packages, so you can use grml-live and FAI completely
-independent!
+CAUTION: grml-live does **not** use /etc/fai for configuration but instead
+provides and uses /etc/grml/fai. This ensures that it does not clash with
+default FAI configuration and packages, so you can use grml-live and FAI
+completely independent at the same time!
 
 [NOTE]
 
@@ -247,11 +255,7 @@ as possiblbe)
 Known TODOs
 -----------
 
-* make sure the suite-target adjusts the mirror definitions according (working
-also vice versa!) and you can define the mirror more central (without having to
-deal with /etc/grml/grml-live.conf, /etc/grml/fai/make-fai-nfsroot.conf and
-/etc/grml/fai/apt/sources.list; debootstrap [FAI_DEBOOTSTRAP] vs. apt inside
-chroot [sources.list] as well)
+* document the available classes in more detail
 
 * make sure $TARGET is mounted rw,suid,dev
 
@@ -261,7 +265,7 @@ chroot [sources.list] as well)
 that are arch specific so we have a clean package list in all classes)
 
 * support different grml-flavours through classes right out-of-the-box (being:
-grml, grml64, grml-small (in progress) for at least x86, amd64 and ppc)
+grml, grml64, grml-small (done) for at least x86, amd64 and ppc)
 
 * support signed apt repositories (currently it's deactivated via FAI's
 FAI_ALLOW_UNSIGNED=1 for some packages in the toolchain)
@@ -271,7 +275,9 @@ FAI_ALLOW_UNSIGNED=1 for some packages in the toolchain)
 * support setting stuff like ISO name, version,... on-the-fly (especially for
 stuff inside boot/isolinux/*)
 
-* support "final builds" (including stuff like generating md5sums, gpg,...)
+* support "final builds" (including stuff like generating md5sums, gpg,... -
+create something like grml_release including all the details about the build
+like dpkg selection, logs,...)
 
 * the grml-live class(es) should send output as used inside FAI as well (so it's
 not as verbose unless you specify it, make it configurable)
@@ -282,8 +288,6 @@ build...)
 
 * support hooks to allow further customisation of the build process
 
-* test the package on non-grml systems (and maybe even non-Debian) as well
-
 Debian package
 --------------