Replace /dev/shm with /grml/grml-live as default target
[grml-live.git] / docs / grml-live.txt
index 5376bfd..9f637c3 100644 (file)
@@ -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
 -----------------
 
@@ -226,9 +250,6 @@ Known TODOs
 * make sure the suite-target adjusts the mirror definitions according (working
 also vice versa!)
 
-* do not use /dev/shm/ als default target directory (which one do we want to use
-instead?)
-
 * 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)