From 09e8bde9f292e537c35387435b5bea9024cf28e8 Mon Sep 17 00:00:00 2001 From: Rob Landley Date: Sat, 4 Feb 2012 12:20:39 -0600 Subject: Add a basic README and an example to "make help". --- README | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README (limited to 'README') diff --git a/README b/README new file mode 100644 index 00000000..4526b1b0 --- /dev/null +++ b/README @@ -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, + +Rob -- cgit v1.2.3