Change OUTPUTDIR fallback to KERNEL_DIR

[genkernel.git] / README

diff --git a/README b/README
index 1032972a3d16bf0cd005518709b50a91f99ac8fd..c202a54c66606f0c079b6499fec19ef2868c7912 100644 (file)
--- a/README
+++ b/README
@@ -1,63 +1,39 @@
-VERY EXPERIMENTAL
-seems to work so far on amd64 and x86
-
-DEPENDANCIES:
-- bootsplash
-- gcc/binutils
-- bash
-
-INSTALLATION:
-
-put genkernel.conf in /etc
-
-put genkernel executable 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:
 
-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 
+  # 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 devfs turned on at this time, but you MUST NOT
-  have "Automatically mount at boot" option turned on. 
-- You MUST have /dev/pts turned on
-- If you want Bootsplash, you MUST have VESAFB enabled for 2.6,
-  other framebuffers won't work.  You MUST also enable
-  "video mode selection support" and "Framebuffer Console support"
-- To build a kernel with GenKernel you must have  
-  "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"
-
+  - You MUST have /dev/pts turned on.
+  - To boot genkernel properly, the kernel config must have
+    Initial RAM disk support.
 
 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 at  0x317 indicates
-      1024x768 - 16bpp   and you'll get a pretty bootsplash if configured properly
-
-
-GRUB EXAMPLE ENTRY:
-title=Linux 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
-
+  GRUB:
+    root=      needs to point to your root partition
+    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/hda3 vga=0x317
+    initrd (hd0,0)/boot/initrd-2.6.0-gentoo