update readme

This commit is contained in:
Sebastian Hugentobler 2015-12-01 12:46:18 +01:00
parent 8750fb8013
commit 15421ccac9
2 changed files with 22 additions and 10 deletions

View File

@ -40,13 +40,13 @@ BOOKLETPDF = $(PDFDIR)/booklet.pdf
MIDITEMPO = 120
all: pdfs midis opus book booklet
all: pdfs midis music book booklet
pdfs: $(PDFS)
midis: pdfs $(MIDIS)
opus: midis $(OPUSFILES)
music: midis $(OPUSFILES)
book: $(BOOKPDF)

View File

@ -18,20 +18,32 @@ with something like [git](http://git-scm.com/).
Development
-----------
Main development happens at https://code.vanwa.ch/sing-alongs but there is a
mirror of the git repository on [Github](https://github.com/thallian/sing_alongs).
The master branch contains only full songs (lyrics, melody and chords) and the
only time it is updated is for changing layout related stuff or merging a song.
Take a look at the command list in the makefile to see what you need for building.
Songs live in their own branch. If there is an error the branch gets fixed and
then merged into the master. I am not sure how well this goes with a growing
number of songs but lets see ;)
Also, the older songs may not have their own branch yet, so it has to be
created when the first correction comes up.
The makefile defines multiple targets:
WRITE SOMETHING ABOUT THE MAKEFILE
- pdfs: builds all songs as single pdfs (without lyrics for now)
- midis: builds the midi file for each song
- music: converts the midi files into opus files
- book: concatenates the songs (with lyrics) to a songbook
- booklet: converts the songbook to a booklet fit for double sided flip printing
To build all just run `make` and it takes care of everything.
License Stuff
-------------
I am still not quite clear on how this works. My understanding is that all these
songs already are in the public domain and there is no need to explicitly set a license.
All copyrights that could arise from other sides (makefile or whatever) are waived
under [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
Contact
-------
You can reach me at [shugentobler@vanwa.ch](mailto:hugentobler@vanwa.ch)