From 3786cdcda1097170076527c9808ab3d4a2e863ab Mon Sep 17 00:00:00 2001 From: Kevin Matz Date: Sun, 21 Oct 2018 01:32:53 -0400 Subject: [PATCH] include instructions for git --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 9e68a01..4c60ce4 100644 --- a/README.md +++ b/README.md @@ -2,29 +2,35 @@ A theoretical exersise to control a Hog 4 via OSC, with comment macros. -The comment macro grammer described in `CommentMacro.g4` was created from the Hog 3.9 manual, Chapter 22.4. The python implementation in `OscCommentMacroListener.py` is based on Chapter 24.2 in the same manual. +The comment macro grammer described in `CommentMacro.g4` is based upon the Hog 3.9 manual, Chapter 22.4. The python implementation in `OscCommentMacroListener.py` is based on Chapter 24.2 in the same manual. -Many macros are unsupported/unsupportable with this method. Some macro freatures, like timing, are not yet implemented. Refer to the **Features** table for specific notes. +Some macros are unsupported/unsupportable with this method. Some macro freatures, like timing, are not yet implemented. Refer to the **Features** table for specific notes. ## Installing Install Python-OSC for output. -``` +```bash $ pip install python-osc ``` Install Antlr4 for input. -``` +```bash $ pip install antlr4-python3-runtime ``` +Use git to retrieve a copy of the code. +```bash +$ git clone http://company235.com/git/kevin/baconscript.git +$ cd baconscript +``` + ## Testing Edit `server.cfg` to the correct values for your Hog4. `comment.py` will accept macros on the command line, or will run an interactive prompt. -``` +```bash $ ./comment.py comment# ``` @@ -34,12 +40,12 @@ Use the builtin command `exit` to quit the interacive prompt. ## Developing You must also install the ANTLR tool. On a mac with homebrew, do: -``` +```bash $ brew install antlr ``` Update the lexer and parser for Python3 -``` +```bash $ antlr -Dlanguage=Python3 CommentMacro.g4 ```