aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJames Pannacciulli <jpnc@jpnc.info>2017-06-11 11:06:44 -0700
committerJames Pannacciulli <jpnc@jpnc.info>2017-06-11 16:28:32 -0700
commit8127bf73501c335519dae40101c3b850c4a64e54 (patch)
treeea3a9b7b3991fda0e23062f89fde6c7177da56d7 /README.md
downloadariketa-8127bf73501c335519dae40101c3b850c4a64e54.tar.gz
ariketa-8127bf73501c335519dae40101c3b850c4a64e54.tar.bz2
ariketa first commit
ariketa: bash example code quickloader for presentations
Diffstat (limited to 'README.md')
-rw-r--r--README.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..445a68c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+ariketa: bash example code quickloader for presentations
+========================================================
+
+Instructions
+------------
+
+- Create an array of examples for ariteka by editing 'config/examples.sh'.
+
+- Source ariketa.sh to your Bash session:
+```
+source ariketa.sh
+```
+
+- View *USAGE* file for usage information.
+
+
+usage
+-----
+ To load ariketa, source it into the bash session you wish to use for the
+ presentation:
+ source ./ariketa.sh
+
+ 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
+ navigate through your examples:
+
+ alt-H: display this USAGE text
+
+ alt-w: load previous example
+ alt-e: load next example
+ alt-a: reload current example
+ alt-h: display current example with syntax highlighting
+
+ alt-W: load previous example without clearing the screen
+ alt-E: load next example without clearing the screen
+ alt-A: reload current example without clearing the screen
+
+ alt-s: side by side diff of previous and current example
+ alt-S: side by side diff of prev/cur examples with highlighting
+ alt-P: toggle between ariketa PS2 header and original setting
+
+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
+ 'config/examples.sh.sample'.