introduce and use bb_basename()

[oweals/busybox.git] / README

diff --git a/README b/README
index 8d6b76a3379af45474d39bc6e3eef4025e063f5f..96ca0bb9d63a9eba047d806b3a795a361ff3cb0e 100644 (file)
--- a/README
+++ b/README
@@ -1,15 +1,16 @@
 Please see the LICENSE file for details on copying and usage.
+Please refer to the INSTALL file for instructions on how to build.
 
 What is busybox:
 
   BusyBox combines tiny versions of many common UNIX utilities into a single
   small executable.  It provides minimalist replacements for most of the
-  utilities you usually find in bzip2, coreutils, file, findutils, gawk, grep,
-  inetutils, modutils, net-tools, procps, sed, shadow, sysklogd, sysvinit, tar,
-  util-linux, and vim.  The utilities in BusyBox often have fewer options than
-  their full-featured cousins; however, the options that are included provide
-  the expected functionality and behave very much like their larger
-  counterparts.
+  utilities you usually find in bzip2, coreutils, dhcp, diffutils, e2fsprogs,
+  file, findutils, gawk, grep, inetutils, less, modutils, net-tools, procps,
+  sed, shadow, sysklogd, sysvinit, tar, util-linux, and vim.  The utilities
+  in BusyBox often have fewer options than their full-featured cousins;
+  however, the options that are included provide the expected functionality
+  and behave very much like their larger counterparts.
 
   BusyBox has been written with size-optimization and limited resources in
   mind, both to produce small binaries and to reduce run-time memory usage.
@@ -40,7 +41,7 @@ Using busybox:
   The behavior of busybox is determined by the name it's called under: as
   "cp" it behaves like cp, as "sed" it behaves like sed, and so on.  Called
   as "busybox" it takes the second argument as the name of the applet to
-  run (I.E. "./busybox ls -l /proc"). 
+  run (I.E. "./busybox ls -l /proc").
 
   The "standalone shell" mode is an easy way to try out busybox; this is a
   command shell that calls the builtin applets without needing them to be
@@ -49,9 +50,10 @@ Using busybox:
 
   The build automatically generates a file "busybox.links", which is used by
   'make install' to create symlinks to the BusyBox binary for all compiled in
-  commands.  Use the PREFIX environment variable to specify where to install
-  the busybox binary and symlink forest.  (i.e., 'make PREFIX=/tmp/foo install',
-  or 'make PREFIX=/tmp/foo install-hardlinks' if you prefer hard links.)
+  commands.  This uses the CONFIG_PREFIX environment variable to specify
+  where to install, and installs hardlinks or symlinks depending
+  on the configuration preferences.  (You can also manually run
+  the install script at "applets/install.sh").
 
 ----------------
 
@@ -63,11 +65,6 @@ Downloading the current source code:
     http://busybox.net/downloads/
 
   You can browse the up to the minute source code and change history online.
-  The "stable" series is at:
-
-    http://www.busybox.net/cgi-bin/viewcvs.cgi/branches/busybox_1_00_stable/busybox/
-
-  And the development series is at:
 
     http://www.busybox.net/cgi-bin/viewcvs.cgi/trunk/busybox/
 
@@ -197,5 +194,5 @@ Supported hardware:
 
 Please feed suggestions, bug reports, insults, and bribes back to the busybox
 maintainer:
-       Erik Andersen
-       <andersen@codepoet.org>
+       Denis Vlasenko
+        <vda.linux@googlemail.com>