From 7344b0ecae675a0d53cf989064f72079a2fda3bf Mon Sep 17 00:00:00 2001 From: Hendrik Langer Date: Thu, 2 Apr 2020 16:27:03 +0200 Subject: [PATCH] update README --- README.md | 36 +++++++++++++++++++++++++++++++++--- 1 file changed, 33 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2b8fbac7..e25de565 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,41 @@ -Patadata +Songbook ======== -[![documentation](http://readthedocs.org/projects/patacrep/badge)](http://patacrep.readthedocs.io) - Songs data for LaTeX songbooks. This data is meant to be processed by the songbook toolkit: - [command line client](https://github.com/patacrep/patacrep) - [gui client](https://github.com/patacrep/patagui) (not up-to-date with this data) - [web client](https://github.com/patacrep/patanet) work in progress. + +## Patadata + +[![documentation](http://readthedocs.org/projects/patacrep/badge)](http://patacrep.readthedocs.io) + +## Getting started + +```console +virtualenv -p python3 venv +source venv/bin/activate +pip3 install songbook +songbook books/songbook-hendrik.yaml +``` + +## Adding a song + +1. Grab the lyrics with chords from [Ultimate guitar](https://ultimate-guitar.com). +2. Hit the edit button and copy the plain text from the pop up (usually has less superfluous newlines than if you copy the text directly). +3. Head to [ultimate.ftes.de](https://ultimate.ftes.de/), select `Latex` from the dropdown in the middle, and paste the text into the left text field. A slightly different version should appear on the right side. +4. Replace any `H` chords on the left side with `B`. If the left side includes German `B` chords that should be English `Bb` chords, replace them also. +5. Create a new file for the song in `./songs//`. +6. Copy and paste the re-formatted Latex version from the right text box on the website into the new file. +7. Add an entry for the new song to `books/songbook-hendrik.yaml`, again in the right order. +8. Fix things. Add the song title and artist to the first line. Have a look at the other song files to find out what the result should look like. Pay special attention to bridges, interludes (especially if they contain only chords and no lyrics), capo instructions. + +## Copyright + +Most songs are copyrighted by the respective owners and can't be redistributed without their permission. We will prepare a version with only traditionals, songs whose copyright has expired, or that were released under a permissive licence by the copyright holder. + +[Patacrep](http://patacrep.com) is released underthe terms of the GNU General Public License. + +[Patadata](https://github.com/patacrep/patadata) is CC-BY-SA.