Skip to content

Commit

Permalink
Add a basic README and an example to "make help".
Browse files Browse the repository at this point in the history
  • Loading branch information
landley committed Feb 4, 2012
1 parent 1bc8463 commit 09e8bde
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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 ''
30 changes: 30 additions & 0 deletions README
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 09e8bde

Please sign in to comment.