Przeglądaj źródła

Update Readme.md: clarity, readability, remove unnecessary transposition hint

sschmidTU 1 rok temu
rodzic
commit
1ddf595d1b
1 zmienionych plików z 6 dodań i 16 usunięć
  1. 6 16
      README.md

+ 6 - 16
README.md

@@ -3,7 +3,7 @@ Extended OSMD, usually exclusive to OSMD Sponsors, with audio player, transposit
 
 Please do not share this code publicly, PhonicScore has the copyright on the additions to public OSMD in this repository.
 You are allowed to use a minified/uglified build of osmd-extended in a website or app, but you are not allowed
-to redistribute the non-minified/uglified code of osmd-extended, or a small modification of it that adds or subtracts little functionality.
+to redistribute the non-minified/uglified code of osmd-extended, or a modification of it.
 
 The code and build process works pretty much the same as OSMD,
 so take a look at the [OSMD Readme (and Wiki)](https://github.com/opensheetmusicdisplay/opensheetmusicdisplay/blob/develop/README.md) for technical info.
@@ -12,9 +12,13 @@ so take a look at the [OSMD Readme (and Wiki)](https://github.com/opensheetmusic
 
 For some tips and tricks using the audio player and osmd-extended specifically, look at this issue: https://github.com/opensheetmusicdisplay/osmd-extended/issues/62
 
-Also note that the layout might be slightly different to public OSMD because we currently use the JustifiedMusicSystemBuilder here, which is exclusive to the sponsor repository and creates justified blocks to try to make systems equally filled and measures similarly stretched.<br>
+Also note that the layout might be slightly different to public OSMD because we currently use the `JustifiedMusicSystemBuilder` here, which is exclusive to the sponsor repository and creates justified blocks to try to make systems equally filled and measures similarly stretched.<br>
 You can turn this off and get the public OSMD layout via `osmd.EngravingRules.UseJustifiedBuilder = false`.
 
+# Sponsor Signup Form
+
+Please don't forget to fill out the sponsor signup form so that we can contact you (and manage your sponsorship and give you access on Discord):<br>
+https://opensheetmusicdisplay.org/github-sponsor-sign-up/
 # Discord Server
 
 Please join our Discord (chat) server for more direct communication and announcement of news: <br>
@@ -22,21 +26,7 @@ https://osmd.org/discord <br><br>
 Please write to @sschmidTU on gitter to confirm your Discord user name and unlock the sponsor channels for you there:
 https://gitter.im/opensheetmusicdisplay/opensheetmusicdisplay
 
-# Sponsor Signup Form
-
-Please don't forget to fill out the sponsor signup form so that we can contact you (and manage your sponsorship and give you access on Discord):<br>
-https://opensheetmusicdisplay.org/github-sponsor-sign-up/
-
 # Class Documentation
 
 To get the class documentation similar to [the one for OSMD](https://opensheetmusicdisplay.github.io/classdoc/), run `npm run docs`.
 The docs will be in `/build/docs`.
-
-## Using transposition without the audio player
-Here is an example HTML of how to use OSMD + transposition plugin:
-[indexFileSelect.html.zip](https://github.com/opensheetmusicdisplay/osmd-extended/files/6024386/indexFileSelect.html.zip)
-<br><br>
-build of transposition plugin for OSMD 0.9.4 - 1.0.0:
-[transpose-osmd-plugin.min.js.zip](https://github.com/opensheetmusicdisplay/osmd-extended/files/6024382/transpose-osmd-plugin.min.js.zip) <br>
-Note that this only works with OSMD 0.9.4+.<br>
-Though since OSMD 1.0, the transposition class has been added to public OSMD.