kevin
/
baconscript
1
0
Fork 0
Code Releases 2 Activity

include instructions for git

This commit is contained in:
Kevin Matz 2018-10-21 01:32:53 -04:00
parent b27a701039
commit 3786cdcda1
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -2,29 +2,35 @@
A theoretical exersise to control a Hog 4 via OSC, with comment macros. 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 ## Installing
Install Python-OSC for output. Install Python-OSC for output.
``` ```bash
$ pip install python-osc $ pip install python-osc
``` ```
Install Antlr4 for input. Install Antlr4 for input.
``` ```bash
$ pip install antlr4-python3-runtime $ 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 ## Testing
Edit `server.cfg` to the correct values for your Hog4. 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. `comment.py` will accept macros on the command line, or will run an interactive prompt.
``` ```bash
$ ./comment.py $ ./comment.py
comment# comment#
``` ```
@ -34,12 +40,12 @@ Use the builtin command `exit` to quit the interacive prompt.
## Developing ## Developing
You must also install the ANTLR tool. On a mac with homebrew, do: You must also install the ANTLR tool. On a mac with homebrew, do:
``` ```bash
$ brew install antlr $ brew install antlr
``` ```
Update the lexer and parser for Python3 Update the lexer and parser for Python3
``` ```bash
$ antlr -Dlanguage=Python3 CommentMacro.g4 $ antlr -Dlanguage=Python3 CommentMacro.g4
``` ```