Ver Fonte

Readme.md: add info for building class documentation

Simon há 3 anos atrás
pai
commit
b1b9c491ed
1 ficheiros alterados com 5 adições e 0 exclusões
  1. 5 0
      README.md

+ 5 - 0
README.md

@@ -11,6 +11,11 @@ so take a look at the [OSMD Readme (and Wiki)](https://github.com/opensheetmusic
 Please join our Discord (chat) server for more direct communication and announcement of news:
 https://osmd.org/discord
 
+# 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
 To use the TranspositionPlugin, you need the build:
 [transpose-osmd-plugin.min.js.zip](https://github.com/opensheetmusicdisplay/osmd-extended/files/6024382/transpose-osmd-plugin.min.js.zip) <br>