diff options
Diffstat (limited to 'USAGE')
| -rw-r--r-- | USAGE | 12 |
1 files changed, 7 insertions, 5 deletions
@@ -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'. |