diff README @ 429:27104029d771

Add a basic README and an example to "make help".
author Rob Landley <rob@landley.net>
date Sat, 04 Feb 2012 12:20:39 -0600
children 5dcfb58916a7
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Sat Feb 04 12:20:39 2012 -0600
@@ -0,0 +1,30 @@
+Toybox: all-in-one Linux command line.
+--- Building Toybox
+Type "make help" for build instructions.
+Mostly you want:
+  CFLAGS="--static" CROSS_COMPILE=armv5l- make defconfig toybox install
+Or "make menuconfig", which produces the same sort of .config file as the
+Linux kernel.
+--- Using toybox
+The build produces a "swiss-army-knife" style multifunction binary, which acts
+differently depending on the name it was called as (cp, mv, cat...), and
+installs symlinks under each command name to populate $PATH.
+The "toybox" command itself uses its first argument as the command name to run
+(ala "toybox ls -l").  With no arguments, it lists available commands.  (This
+allows you to use the commands even without the symlinks.)
+The "help" command provides information about each command (ala "help cat").
+The toybox web page is at "http://landley.net/toybox".
+Have fun,