Skip to content
This repository has been archived by the owner on Sep 6, 2023. It is now read-only.

update readme.md and github user page? #35

Open
aerhard opened this issue Jun 4, 2014 · 2 comments
Open

update readme.md and github user page? #35

aerhard opened this issue Jun 4, 2014 · 2 comments

Comments

@aerhard
Copy link

aerhard commented Jun 4, 2014

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
Copy link

👍 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
Copy link
Author

aerhard commented Jun 28, 2014

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)

@aerhard aerhard mentioned this issue Jul 5, 2014
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants