Feature/generic fingering diagrams (#8)

* Use the Fiati music font
* Add Recorder diagram
* Generic fingering that can be used for clarinet, oboe, bassoon, saxophone, etc

.gitignore

@@ -0,0 +1,40 @@
+# OS X
+*.DS_STORE
+*__MACOSX
+.Spotlight-V100
+._.Trashes
+.Trashes
+.fseventsd
+.VolumeIcon.icns
+.AppleDouble
+.LSOverride
+Icon?
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# Windows
+Thumbs.db
+Desktop.ini
+$RECYCLE.BIN/
+ehthumbs.db
+*.lnk
+
+# Editors
+*.bak
+*.vfbak
+*.~tt
++.idea/*
+vscode/
+
+# Shares
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+$RECYCLE.BIN/
+.Spotlight-V100
+.Trashes

README.md

@@ -1,32 +1,36 @@
-# Flute Fingering plugin for Musescore 3.x
+# Fingering Diagram plugin for MuseScore 3.x
 
-Flute Fingering Plugin for MuseScore 3.x is a tool to create scores with flute fingering.
+Fingering Diagram Plugin for MuseScore 3.x is a tool to create scores with instrument fingering diagrams.
 
 ### Introduction
-This is a plugin that automatically adds fingering for Concert Flute or Piccolo to the score. Note that
-if the staff instrument is not a flute (`wind.flutes.flute*`) then no fingering will be applied.
+This is a plugin that automatically adds fingering diagram/chart for different musical instruments (initially for windwood) to the score. Note that if the staff instrument is not a wind instrument (`wind.*`) then no fingering will be applied. Those are the instruments with mapping created:
+
+* Flute (wind.flutes.flute)
+* Piccolo (wind.flutes.flute.piccolo)
+* Soprano Recorder (wind.flutes.recorder)
 
 ### Installation
-* If using MuseScore version 3 then download the [plugin](https://github.com/eduardomourar/flute-fingering/archive/master.zip) and unzip it.
+* If using MuseScore version 3 then download the [plugin](https://github.com/eduardomourar/fingering-diagram/archive/master.zip) and unzip it.
 
-* Install using the [instructions](https://musescore.org/en/handbook/3/plugins#installation) in the MuseScore 3.x Handbook, which typically 
-involves copying the QML file to the local MuseScore Plugin directory.
+* Install using the [instructions](https://musescore.org/en/handbook/3/plugins#installation) in the MuseScore 3.x Handbook, which typically involves copying the QML file to the local MuseScore Plugin directory.
 
 * Open MuseScore and navigate to ['Plugins' -> 'Plugin Manager'](https://musescore.org/en/handbook/3/plugins#enable-disable-plugins)
-to enable the plugin. Tick the box against 'flutefingering' and apply with 'OK'.
+to enable the plugin. Tick the box against 'fingeringdiagram' and apply with 'OK'.
+
+* This plugin relies on **Fiati** font being installed, which can be downloaded here: https://github.com/eduardomourar/fiati/releases
+
+### Known issues
+
+Sometimes the diagrams are placed too close together. In order to improve readability, you can either make the font smaller, or set the [minimum note distance](https://musescore.org/en/handbook/3/measure#options) to 1.5sp or higher. 
 
-* This plugin relies on a font being installed **concertflutefingering-v1.ttf**, which is included in this
-download. To install the font, it is usually just a case of double-clicking the downloaded `.ttf` file 
-and agreeing to the install process.
+### Preview
+
+Image exported from the [sample MuseScore file](./sample.mscx) included in this project.
+
+![Screenshot](./screenshot.png)
 
 ## IMPORTANT
 NO WARRANTY
-THE PROGRAM IS DISTRIBUTED IN THE HOPE THAT IT WILL BE USEFUL, BUT WITHOUT ANY WARRANTY. IT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE,
-YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW THE AUTHOR WILL BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL,
-SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM
-(INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES
-OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE POSSIBILITY
-OF SUCH DAMAGES.
+THE PROGRAM IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW THE AUTHOR WILL BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.