aboutsummaryrefslogtreecommitdiff
path: root/toys/example/README
diff options
context:
space:
mode:
authorRob Landley <rob@landley.net>2017-10-31 15:51:02 -0500
committerRob Landley <rob@landley.net>2017-10-31 15:51:02 -0500
commite913247fec162437920266182834aedadcb03004 (patch)
tree8f61ef4d6dfdb0d256279d4e5e34347f498aa13b /toys/example/README
parentb2d8cf906502226904e149e20279a899ba22e035 (diff)
downloadtoybox-e913247fec162437920266182834aedadcb03004.tar.gz
Rename test_*.c to demo_*.c (because "make test_$CMD" means something already),
fluff out README, and add a comment to hostid explaining its deprecation.
Diffstat (limited to 'toys/example/README')
-rw-r--r--toys/example/README10
1 files changed, 10 insertions, 0 deletions
diff --git a/toys/example/README b/toys/example/README
index d0f6631a..a3af8519 100644
--- a/toys/example/README
+++ b/toys/example/README
@@ -2,3 +2,13 @@ Example commands
You probably don't want to deploy this, but it shows how to use the
toybox infrastructure and provides templates for new commands.
+
+The hello.c and skeleton.c commands provide templates: hello.c is clean and
+simple, skeleton.c demonstrates the option parsing infrastructure and having
+multiple commands per file. When writing a new command, copying hello.c or
+skeleton.c to the new name may provide a good starting point.
+
+The demo_* commands demonstrate infrastructure.
+
+Other commands in here are obsolete versions still in some recent Linux systems
+(and often still in posix), but not really useful on modern systems.