search

TEI-Music-SIG / MEItoVexFlow

JavaScript libray to render MEI notation using VexFlow
20 stars 9 forks source link

update readme.md and github user page? #35

Open aerhard opened 10 years ago

aerhard commented 10 years ago

The GitHub demo page looks a little bit out of date -- I think it would be nice to add some examples showing the current capabilities of MEItoVexFlow. What do you guys think? I'm asking myself if the options parameter of render_notation (src/Interface.js), which passes most of its parts to src/Converter.js, should be described in readme.md. That should depend on whether we consider it as a part of the official API or not -- generally, I would tend to add it, but I think we should discuss its design before.

raffazizzi commented 10 years ago

:+1: I wish I had the time! :) I think the readme should give a basic example of how to set up a working instance of MEItoVexFlow; all the parameters of render_notation can be explained elsewhere.

aerhard commented 10 years ago

I fully agree - forgot about the js documentation in the meantime; providing it there would be the best place (I keep the issue open for the update of the github user page)