Another update from Larry:
[oweals/busybox.git] / README
diff --git a/README b/README
index 5ffa6c1b6bb6238b850189007e3a221c2abdcb3c..cea4a68e2f8e63e8077f2c6dd4cb9051c76e0be7 100644 (file)
--- a/README
+++ b/README
@@ -11,8 +11,9 @@ the expected functionality and behave very much like their GNU counterparts.
 BusyBox has been written with size-optimization and limited resources in mind.
 It is also extremely modular so you can easily include or exclude commands (or
 features) at compile time. This makes it easy to customize your embedded
-systems. To create a working system, just add a kernel and an editor (such as
-e3 (http://www.sax.de/~adlibiti) or elvis-tiny).
+systems. To create a working system, just add /dev, a shell, and a kernel.  For
+a really minimal system, you can even use the busybox shell (not Bourne
+compatible, but very small and quite usable) and the busybox vi editor.
 
 BusyBox was originally written to support the Debian Rescue/Install disks, but
 it also makes an excellent environment for any small or embedded system.
@@ -27,7 +28,25 @@ After the build is complete, a busybox.links file is generated.  This is
 used by 'make install' to create symlinks to the busybox binary for all
 compiled in functions.  By default, 'make install' will place the symlink
 forest into `pwd`/_install unless you have defined the PREFIX environment
-variable (i.e., make PREFIX="/tmp/foo" install)
+variable (i.e., 'make PREFIX=/tmp/foo install')
+
+----------------
+    
+Supported architectures:
+
+   Busybox in general will build on any architecture supported by gcc.  It has
+   a few specialized features added for __sparc__ and __alpha__.  insmod
+   functionality is currently limited to x86, ARM, SH3/4, powerpc, and MIPS.
+
+Supported libcs:
+
+   glibc-2.0.x, glibc-2.1.x, Linux-libc5, uClibc.  People are looking at
+   newlib and diet-libc, but consider them unsupported, untested, or worse.
+
+Supported kernels:
+
+   Full functionality requires Linux 2.0.x, 2.2.x, or 2.4.x.  A large fraction
+   of the code should run on just about anything.
 
 ----------------
 
@@ -52,7 +71,7 @@ to submit@bugs.lineo.com.  Bug reports should look something like this:
     Subject: /bin/true doesn't work
 
     Package: busybox
-    Version: 0.48
+    Version: 0.51
 
     When I invoke '/bin/true' it doesn't work.  I expected it to return 
     a "0" but it returned a "1" instead.  Here is the transcript:
@@ -96,6 +115,7 @@ Please feed suggestions, bug reports, insults, and bribes back to:
        Erik Andersen 
        <andersen@lineo.com>
        <andersee@debian.org>
+       <andersee@codepoet.org>
 
 <blatant plug>
 Many thanks to go to Lineo for paying me to work on busybox.