X-Git-Url: https://git.grml.org/?a=blobdiff_plain;f=docs%2Fgrml-live.txt;h=9f637c318459a0b0af1f8f7bae31ab5d3b7a413b;hb=ae03bb245582f7184394f2b7e254f4907cb2e4ab;hp=91b40e80f9951a7a5770a1ba1efe6a306fc79406;hpb=8ebdabd250a8c349d0832aba0e79f60f3a3ab95c;p=grml-live.git

diff --git a/docs/grml-live.txt b/docs/grml-live.txt
index 91b40e8..9f637c3 100644
--- a/docs/grml-live.txt
+++ b/docs/grml-live.txt
@@ -38,7 +38,7 @@ packages will be installed via network. If you want to use a local mirror
 (strongly recommended!) checkout mkdebmirror (see
 /usr/share/doc/grml-live/examples/mkdebmirror), debmirror(1), reprepro(1) (see
 /usr/share/doc/grml-live/examples/reprepro/ for a sample configuration) and
-approx. To avoid downloading of the base system check out FAI's NFSROOT (check
+approx(8). To avoid downloading of the base system check out FAI's NFSROOT (check
 docs for ../fai/nfsroot/live/filesystem.dir/var/tmp/base.tgz).
 
 Options
@@ -57,8 +57,11 @@ Specify the Debian suite you want to use for your live-system.  Defaults to
 
   -t **TARGET_DIRECTORY**::
 
-Output directory of the build process of FAI - being the chroot
-used for building the ISO.
+Main output directory of the build process of FAI.  Three directories are
+created inside the target directory, being: grml_cd/ - where the files for
+creating the ISO are located (including the compressed squashfs file),
+grml_chroot/ - the generated chroot system and grml_isos/ - where the resulting
+ISO is stored.
 
   -F::
 
@@ -76,11 +79,16 @@ Increase verbosity in the build process.
 How to get your own live-cd - the easy, fast and simple way
 -----------------------------------------------------------
 
-To get a small, Debian-stable and grml based live-cd using /dev/shm/
+To get a small, Debian-stable and grml based live-cd using /grml/grml-live
 as build and output directory:
 
   # grml-live
 
+To get a small Debian-unstable and grml-small based live-cd using
+/home/mika/grml-live as build and output directory:
+
+  # grml-live -c GRMLBASE,GRML_SMALL,I386 -t /home/mika/grml-live
+
 [NOTE]
 
 If you have about 700MB of free space inside /dev/shm (being a tmpfs, usually
@@ -90,6 +98,22 @@ But please be aware of the fact that rebooting your system will result in an
 empty /dev/shm, so please another directory for $CHROOT_TARGET, $BUILD_TARGET
 and $ISO_TARGET if you plan to create more persistent output. :)
 
+Features
+--------
+
+* create a grml-/Debian-based Linux Live-CD with one single command
+
+* class based concept, providing a maximum of flexibility
+
+* supports integration of own hooks, scripts and configuration
+
+* supports use and integration of own Software and/or Kernels via use of Debian
+repositories
+
+* native support of FAI features
+
+* multi-arch support (work in progress)
+
 The class concept
 -----------------
 
@@ -223,8 +247,8 @@ as possiblbe)
 Known TODOs
 -----------
 
-* do not use /dev/shm/ als default target directory (which one do we want to use
-instead?)
+* make sure the suite-target adjusts the mirror definitions according (working
+also vice versa!)
 
 * add support for amd64 [gebi?] + ppc [formorer?] (and identify all packages
 that are arch specific so we have a clean package list in all classes)
@@ -233,22 +257,26 @@ that are arch specific so we have a clean package list in all classes)
 grml, grml64, grml-small (in progress) 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)
+FAI_ALLOW_UNSIGNED=1 for some packages in the toolchain)
 
 * explain (and provide configuration for) use of NFSROOT
 
-* support setting stuff like ISO name, version,... (especially for stuff inside
-boot/isolinux/*)
+* 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,...)
 
 * 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)
 
-* provide possibility for cleanup of all created build directories
+* provide possibility for cleanup of all created build directories and
+a smart summary of the buildprocess (including "took ... minutes/seconds to
+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
 --------------