2.1.0 • Published 8 years ago

notelex v2.1.0

Weekly downloads
5
License
CC-BY-NC-ND-4.0
Repository
github
Last release
8 years ago

notelex

Build Status

Notelex is a widget to compare different approaches in music theory

Installation

The notelex library depends on jquery, jquery.klavier and vexflow.

With browserify/webpack etc.:

# install dependencies:
$ npm install jquery jquery.klavier vexflow

# install notelex:
$ npm install notelex

... or as a global script:

<script src="path/to/jquery.js"></script>
<script src="path/to/jquery.klavier.js"></script>
<script src="path/to/vexflow.js"></script>
<script src="node_modules/dist/notelex.min.js"></script>

Usage

notelex.init({
  pianoSelector: '#piano',
  theoryHeadersSelector: '#theoryHeaders',
  theoryContentSelector: '#theoryContent',
  scoreCanvasSelector: '#scoreCanvas'
});

Also, see the example index.html file within this repository.

License

Licensed under the CC-BY-NC-ND-4.0 license (http://creativecommons.org/licenses/by-nc-nd/4.0/legalcode). However we explicitly allow forks of this repository in order to create pull requests.