Slight tweak of the README.md to be a more specific about usage.

This commit is contained in:
Eric Teunis de Boone 2021-03-11 12:15:50 +01:00
parent 0497db972d
commit 68fb47f675
1 changed files with 55 additions and 24 deletions

View File

@ -16,19 +16,49 @@ This repository has also been converted into a [lyp](https://github.com/noteflak
## How to use
---------------------
To make a pipeband drum staff simply use
`\new PipeBandDrumStaff`.
This creates a DrumStaff with a few specific changes.
Add the following line to include the definitions for use in your document:
```lilypond
\include "[path]/lilydrum.ly"
```
!! Note that you do not need to use PipeBandDrumStaff to use the rest.
The music needs to be defined in a `\drummode` environment.
You can get this in two ways:
```lilypond
\new DrumStaff {
\drummode {
[music]
}
}
```
or (simply)
```lilypond
\drums {
[music]
}
```
### Music
In pipeband music there is a distinction between left-hand and right-hand strokes.
To implement this in your music you can use the `d` and `g` notenames.
* `d`: (*droite*) right hand
* `g`: (*gauche*) left hand
*You can still use the regular drumcharacters (such as `sn` or `bd`) in your music.*
### Pipeband DrumStaff
To make a pipeband drumstaff (a `DrumStaff` with a few specific changes) you can use
```lilypond
\new PipeBandDrumStaff
```
*You do not need to use PipeBandDrumStaff to use the music definitions.*
Music needs to be defined in `\drummode`.
You can use every regular drum character (such as `sn` or `bd`), as `d` and `g` are appended to the list.
## Example piece
*(see [./example.ly](./example.ly) for fully annotated code and its [score](./example.pdf))*
![preview of the score](./example.preview.png)
This was generated by the following code.
```lilypond
@ -63,14 +93,14 @@ This was generated by the following code.
}
}
```
see [./example.ly](./example.ly) for fully annotated code and its [score](./example.pdf).
### Embellishments (Side)
-----------------
Flams and Drags can be added using `\flam` and `\drag`. They can determine whether to be left or right by themselves for simple expressions.
### Embellishments (Side Drum)
Flams and Drags can be added using `\flam` and `\drag`.
They can determine whether to be left or right by themselves for simple expressions.
If a certain hand is needed they can be inserted directly by appending `d` or `g` to `flam`,`drag`,..
A `\flam d` is equal to `\flamd d`.
e.g. a `\flam d` is equal to `\flamd d`.
There are currently 4 such shortcuts:
* `\flam` - A Flam
@ -78,8 +108,8 @@ There are currently 4 such shortcuts:
* `\ruff` - A Ruff
* `\sruff` - A Swiss Ruff
### Unison Brackets (Side)
------------------
### Unison Brackets (Side Drum)
Unison Brackets are triggered using `\dr`.
They need an endpoint which is defined by `\fr`.
@ -87,10 +117,11 @@ You can use `\tutti` for this aswell.
It takes a music expression which is automagically put under brackets.
Appending `dr` to the `\flam`'s or `\drag`'s triggers the unison bracket.
e.g. `\flamdr` of `\draggdr`.
e.g. `\flamdr` or `\draggdr`.
### Flourishing (Tenor Drum)
### Flourishing (Tenor)
-------------
A few flourishes have been added, most are from the [EUSPBA](http://www.euspba.org/resource/music/EUSPBA_drums_tenorflourishing.pdf):
* `\flourish`
* `\splitTheFeather`