aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRob Landley <rob@landley.net>2012-02-04 12:20:39 -0600
committerRob Landley <rob@landley.net>2012-02-04 12:20:39 -0600
commit09e8bde9f292e537c35387435b5bea9024cf28e8 (patch)
treeb7b4ed183e531fd466d804fb336ce718d16c37fd
parent1bc8463cb98580024fa9453723e0ded0bfd19233 (diff)
downloadtoybox-09e8bde9f292e537c35387435b5bea9024cf28e8.tar.gz
Add a basic README and an example to "make help".
-rw-r--r--Makefile3
-rw-r--r--README30
2 files changed, 33 insertions, 0 deletions
diff --git a/Makefile b/Makefile
index df24c513..e4d88828 100644
--- a/Makefile
+++ b/Makefile
@@ -62,3 +62,6 @@ help::
@echo ' install - Install toybox into subdirectories of $$PREFIX.'
@echo ' uninstall_flat - Remove toybox from $$PREFIX directory.'
@echo ' uninstall - Remove toybox from subdirectories of $$PREFIX.'
+ @echo ''
+ @echo 'example: CFLAGS="--static" CROSS_COMPILE=armv5l- make defconfig toybox install'
+ @echo ''
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