diff options
authorRunasSudo <runassudo@yingtongli.me>2020-05-23 03:19:49 +1000
committerRunasSudo <runassudo@yingtongli.me>2020-05-24 03:49:43 +1000
commit21c14c57dd56a2526a5e85b3e2db5d28ec5535c1 (patch)
parent07f6ba2d18e08ee06e0deb3a0618a85bc5b9495a (diff)
Update documentation
Add screenshot
-rw-r--r--Screenshot.pngbin0 -> 16971 bytes
2 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index a081762..8366a8b 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,8 @@
*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.
@@ -12,6 +14,10 @@ Load the XML file into Musescore via *Format → Style → Chord Symbols → App
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`).
+### Fonts
+The layout parameters in these XML files are designed for, and expect, the *FreeSerif* and *FreeSans* fonts.
## 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.
diff --git a/Screenshot.png b/Screenshot.png
new file mode 100644
index 0000000..8a473a1
--- /dev/null
+++ b/Screenshot.png
Binary files differ
Contact (issues, pull requests, etc.) at git@yingtongli.me. Generated by cgit.