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

Adding a tutorial/minimal working example to help new users? #152

Open
Speldosa opened this issue Sep 25, 2016 · 4 comments
Open

Adding a tutorial/minimal working example to help new users? #152

Speldosa opened this issue Sep 25, 2016 · 4 comments

Comments

@Speldosa
Copy link

Speldosa commented Sep 25, 2016

Would you consider creating a short tutorial or minimal working example for all us Lilypond n00bs out there (in my case, I still feel like a n00b although I've created several scores within Lilypond)? I've been really exited to try out the different styles (for example Improviso which looks absolutely stunning), but haven't been able to do it.

I think that there are a lot of potential users like me that are discourages from the library because of the rather high bar of entry, and a simple tutorial (going from downloading the library, placing it in a certain path, writing a minimal working example ly file, and horsing around with the --include commands in the terminal) would probably somewhat alleviate that problem. (I would be willing to contribute with such a tutorial myself if somebody just could give me a few pointers on how to do it.)

screenshot 2016-09-25 16 17 17

screenshot 2016-09-25 16 18 07

@PaulMorris
Copy link

Maybe adding such a tutorial to the material on the wiki?

https://github.com/openlilylib/snippets/wiki/Installation

-Paul

On 09/25/2016 10:08 AM, Martin Larsson wrote:

Would you consider creating a short tutorial or minimal working
example for all us Lilypond n00bs out there (in my case, I still feel
like a n00b although I've created several scores within Lilypond)?
I've been really exited to try out the different styles (for example
Improviso which looks absolutely stunning), but haven't been able to
do it.

I think that there are a lot of potential users like me that are
discourages from the library because of the rather high bar of entry,
and a simple tutorial (going from downloading the library, placing it
in a certain path, writing a minimal working example ly file, and
horsing around with the --include commands in the terminal) would
probably somewhat alleviate that problem. (I would be willing to
contribute with such a tutorial myself if somebody just could give me
a few pointers on how to do it.)

screenshot 2016-09-25 16 06 03
https://cloud.githubusercontent.com/assets/1475822/18815787/3b5a697e-833a-11e6-958d-f54ce1cbc7ad.png
screenshot 2016-09-25 16 07 30
https://cloud.githubusercontent.com/assets/1475822/18815786/3b59bace-833a-11e6-822e-0fcbb56fbaf6.png


You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
#152, or mute the
thread
https://github.com/notifications/unsubscribe-auth/ABCobdDe1VNVQRoduLiZlxC0KnR6s9inks5qtoBKgaJpZM4KF6O8.

@Speldosa
Copy link
Author

Speldosa commented Sep 26, 2016

Sure, that would be one way of doing it (and then add a link to the wiki from the readme, saying that more detailed instructions can be found there).

@uliska
Copy link
Contributor

uliska commented Sep 26, 2016

There's one fundamental problem with the documentation: the annoying fact that much of openLilyLib is so temporary.

Specifically the "packages" below the /ly directory are actually all due to be moved to independent packages that work together with the oll-core package. And I'm still waiting for the opportunity and spare time (haha) to think about and implement a sustainable and comprehensive solution for documenting these packages and the openLilyLib system.

But as an interim solution (that may well be integrated in a future "proper" solution) I'm all for creating any kind of tutorial material. I see several options for this (and will gladly give a helping hand):

  • Extending the Wiki as mentioned (maybe with adding a more explicit link on the main README page)
  • Writing a tutorial on Scores of Beauty
  • Adding a section on the (awfully-WIP) "LilyPond Book"
  • Writing documentation section(s) as Markdown files in the actual repository (will be rendered in the Github interface)
  • Writing something on https://openlilylib.org (requires knowledge in writing AngularJS based web applications (actually: helping me getting on track again ;-) )
  • Writing something as a GitBook, which can be uploaded somewhere on openlilylib.org

@Speldosa
Copy link
Author

Yeah, it would probably be a good idea too start describing things at the highest level first. I've been looking around a bit in this whole openlilybib repository, and I can't really figure out what's what and how everything fits together.

(I came here from this blog post on Scores of Beauty, just because I wanted to use a different music font, and now I feel quite lost why I even needed to come here in the first place; why couldn't I simply go to the improviso page, download the font, and do... something?)

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

3 participants