Merge branch 'bug-421027'

[genkernel.git] / README

diff --git a/README b/README
index 1735896e8750bf9e418834946671a5c11664c6c5..196e956b9e6aa94e4d70b7ccc39c241273405303 100644 (file)
--- a/README
+++ b/README
@@ -1,38 +1,44 @@
-VERY EXPERIMENTAL
-seems to work so far on amd64 and x86
-I've only tested with 2.6 kernels, it's possible that
-the module-init-tools we use doesn't work with 2.4 in
-which case we need to compile modutils as well and
-provide a static binary for that....
-
-DEPENDANCIES:
-- bootsplash
-- gcc/binutils
-- bash
-
-INSTALLATION:
-
-put genkernel.conf in /etc
-
-put genkernel.sh in /usr/bin
-
-put the rest of the files and directories in /usr/share/genkernel
+# $Id$
 
+DEPENDENCIES:
+  - GCC and binutils
+  - GNU Bash
+  - PaX Utilities
 
+USAGE:
+  See http://www.gentoo.org/doc/en/genkernel.xml or
+  issue ``genkernel --help''.
 
 PORTING:
-
-To port to other arches:
-
-cd /usr/share/genkernel
-cp -Rp x86 ${myarch}
-mkdir /usr/share/genkernel/pkg/${myarch}
-
-
-modify what is needed in the /usr/share/genkernel/${myarch}
-directory, this is all the arch-specific stuff, as well
-as a generic kernel-config 
-
-
-
-
+  To port to other arches:
+
+  # cd /usr/share/genkernel
+  # cp -Rp x86 ${myarch}
+  # mkdir /usr/share/genkernel/pkg/${myarch}
+
+  Modify what is needed in the /usr/share/genkernel/${myarch}
+  directory, as well making a generic kernel-config.
+
+IMPORTANT KERNEL NOTES:
+  - You MUST have /dev/pts turned on.
+    "Block devices->Loopback device support"  
+    "Block devices->RAM disk support"
+  - To boot genkernel properly, the kernel config must have
+    RAM disk support and Initial RAM disk support. You should
+    also set your "Default RAM disk size to 8192"
+
+BOOTING A KERNEL WITH INITRD:
+
+  GRUB:
+    real_root= needs to point to your root partition
+    root=      needs to point to the ramdisk (should stay at /dev/ram0)
+    init=      needs to point to the linuxrc file to execute on the ramdisk
+    vga=       should be the resolution you want your screen. 0x317 is
+               1024x768 - 16bpp and you'll get a pretty splash if
+               configured properly
+
+  GRUB EXAMPLE ENTRY:
+    title=2.6.0 [ Genkernel ]
+    root (hd0,0)
+    kernel (hd0,0)/boot/kernel-2.6.0-gentoo root=/dev/ram0 init=/linuxrc real_root=/dev/hda3 vga=0x317
+    initrd (hd0,0)/boot/initrd-2.6.0-gentoo