aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRunasSudo <runassudo@yingtongli.me>2020-05-23 02:58:15 +1000
committerRunasSudo <runassudo@yingtongli.me>2020-05-23 03:06:24 +1000
commit7af4eb832c7ba705c8ec04544aca7e54fc4414ad (patch)
tree29f43dabb21424f73a2cc1a1252f300db7eceea8
parentbb9721a9fc31a7341238fa84418dc2c3ebc58aea (diff)
Add README.md
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a081762
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# musescore-serifjazz-chords
+
+*musescore-serifjazz-chords* provides a [Musescore](https://musescore.org/) [chord symbol style file](https://musescore.org/en/handbook/chord-symbols#appearance) with Jazz-style superscripts and font distinctions, while using standard (sans-)serif fonts congruent with standard engraving formatting.
+
+## Usage
+
+From the [files in this repository](https://yingtongli.me/git/musescore-serifjazz-chords/tree/), download the XML file corresponding to the desired staff spacing. XML files are available for the default spacing of 1.764mm, and for various Rastral sizes.
+
+Load the XML file into Musescore via *Format → Style → Chord Symbols → Appearance → Custom*.
+
+### Additional features
+
+To achieve better kerning with A chords, use `*`. For example, type `A*7` or `A*o` instead of `A7` or `Ao` to position the modifier/extension more snugly with the ‘A’. The exception is the half diminished (ø) chord, for which you should type `A*h` (not `A*0`).
+
+## Information for contributors
+
+XML files corresponding to specific staff sizes should not be directly edited. They are automatically generated from *chords_serifjazz.m4.xml*. This is an [m4](https://en.wikipedia.org/wiki/M4_%28computer_language%29) file, which automatically substitutes appropriate layout parameters for each staff size.
+
+Output XML files can be regenerated using the *build.sh* script. Additional staff sizes can be introduced by editing this script.
Contact (issues, pull requests, etc.) at git@yingtongli.me. Generated by cgit.