Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

osc2midi syntax description #26

Closed
agraef opened this issue Jan 12, 2017 · 5 comments
Closed

osc2midi syntax description #26

agraef opened this issue Jan 12, 2017 · 5 comments

Comments

@agraef
Copy link
Contributor

agraef commented Jan 12, 2017

Hi Spencer, attached is a Markdown file with documentation of the osc2midi map file syntax and the meaning of the various constructs. The Examples section is still missing, but I guess that it should be useful even as it is, so I'm tossing it here so that you can have a look and decide whether you might add it to the repo. I've had this lying around on my hard disk for much too long, wanting to finish it before submitting, but given that I'm always busy with so many other projects, it's unlikely that I can finish it any time soon. So here goes...
syntax.md.zip

@agraef
Copy link
Contributor Author

agraef commented Jan 12, 2017

For the time being, I've also uploaded the file to the osc2midi-utils wiki, so that it doesn't go to waste. You can find it here: https://bitbucket.org/agraef/osc2midi-utils/wiki/Home

@ssj71
Copy link
Owner

ssj71 commented Jan 18, 2017

I've looked a little at it, sorry I haven't replied yet. My only thought is that the BNF is a bit intimidating if you aren't familiar with BNF (which I am not). I wonder if we could put that in a separate, linked file so its not the first thing users are presented with when they look at it? I can do that when I add it here if you think that would be ok.

@agraef
Copy link
Contributor Author

agraef commented Jan 18, 2017

Yeah, that's a good idea, but I'd simply put it in an appendix at the end of the document so that everything is in a single file. Also, the Syntax section then needs some rewording and expanding so that the remarks about the path and argtypes syntax make any sense. I'll rework it asap.

@ssj71
Copy link
Owner

ssj71 commented Feb 15, 2017

I was looking at this and went ahead and threw it in with some minor edits. Feel free to contribute PRs for edits as you see fit. Thanks for this!

@ssj71 ssj71 closed this as completed Feb 15, 2017
@agraef
Copy link
Contributor Author

agraef commented Feb 16, 2017

Thanks for taking care of it. Sorry for the high latency, I'm too busy with other projects right now. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants