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

Add examples and get-started section #30

Open
truj opened this issue Nov 5, 2019 · 1 comment
Open

Add examples and get-started section #30

truj opened this issue Nov 5, 2019 · 1 comment

Comments

@truj
Copy link

truj commented Nov 5, 2019

The project's scope looks promising.
The scope seems to be very similar to my own project: https://github.com/truj/midica

However I have problems to even try out MellowD.

Reasons:

  • The langRef.md seems to be good as a lookup table for people who already know the language but it cannot replace a tutorial.
  • The website doesn't work for me. When pressing compile, I only get "HTTP Error"

I know, issue #9 already addresses documentation but a good documentation is a lot of work, taking a lot of time.

So I suggest the following:

  • add at least one simple .mlod example file (with a lot of comments explaining the source)
  • add a get started section in the Readme file, covering the necessary steps how to compile an .mlod file to MIDI

I think that's not too much of work but it would enhance usibility a lot.

@SpencerPark
Copy link
Owner

Hi @truj, thanks for reaching out and sharing midica, it looks very cool!

This started as a school project which I've been developing since when I get time/interest as needed for performances. More recently it has morphed into a live coding language for that purpose.

The documentation was a requirement for the project which is why it stopped getting developed after the course was finished :/ as is the issue on the website since my aws lambda student account is no longer valid.

My open source contributions have been hurting as of late, but I completely agree with your points about some quicker docs to get users off the ground. I wrote a Jupyter kernel which I use for performing and was hoping to take advantage of that for a tutorial as well. Jupyter notebooks are really great for teaching and with mybinder.org would allow for interactive in-browser try-it-online style docs without needing a server.

I don't want to get your hopes up that it will happen soon, but would like to get the project/language to the point where other people could enjoy it besides just myself and the first step to that is documentation.

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