aboutsummaryrefslogtreecommitdiffstats
path: root/USAGE
diff options
context:
space:
mode:
authorJames Pannacciulli <jpnc@jpnc.info>2017-11-29 01:00:28 -0800
committerJames Pannacciulli <jpnc@jpnc.info>2017-11-29 01:00:28 -0800
commit0074b6f1fbc8b0a550dd7f2461b993225249a9e3 (patch)
tree816f3c3e828248ded021ad46f9b1e3b98e44d19e /USAGE
parentd9141ad42b5eff24f826174bd4f4676e85ce3b20 (diff)
downloadariketa-0074b6f1fbc8b0a550dd7f2461b993225249a9e3.tar.gz
ariketa-0074b6f1fbc8b0a550dd7f2461b993225249a9e3.tar.bz2
add support for specifying custom examples file or instantiated array name
Diffstat (limited to 'USAGE')
-rw-r--r--USAGE12
1 files changed, 7 insertions, 5 deletions
diff --git a/USAGE b/USAGE
index 7403d76..75e92a3 100644
--- a/USAGE
+++ b/USAGE
@@ -4,8 +4,12 @@ ariketa: bash example code quickloader for presentations
usage
-----
To load ariketa, source it into the bash session you wish to use for the
- presentation:
- source ./ariketa.sh
+ presentation. If no array name or filename is provided to source the
+ _examples array from, ariketa will attempt to load 'config/examples.sh'
+ from the ariketa directory:
+ source ariketa
+ source ariketa [-a|--array EXAMPLES_ARRAYNAME]
+ source ariketa [EXAMPLES_FILENAME]
When an example is displayed, it may be edited like any command line and
executed normally by pressing enter. Use the following key bindings to
@@ -30,7 +34,5 @@ configuration
-------------
To load examples into ariketa, edit the 'examples.sh' file in the
'config' directory. This file should be a sourceable bash script which
- creates an indexed array named '_examples', whose elements have values
- beginning with a tag, delineated from the example itself by a ':' character
- followed by a newline. An sample config is located in
+ creates an indexed array named '_examples'. An sample config is located in
'config/examples.sh.sample'.