Skip to content

Commit d193320

Browse files
Prepare for release
1 parent b2fc2a7 commit d193320

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
purescript-vexflow
22
==================
33

4-
Work in progress.
5-
64
This is a purescript wrapper for [VexFlow](http://www.vexflow.com/) which is designed to cover just enough of the API in order to allow the engraving of music scores produced by the [ABC parser](https://github.com/newlandsvalley/purescript-abc-parser).
75

86
It is intended to be a replacement for [purescript-scores](https://github.com/newlandsvalley/purescript-scores) which itself was a wrapper for [VexTab](http://www.vexflow.com/vextab). i.e. the intention is to cut out the middle man (which is anyhow not regularly maintained).
@@ -22,3 +20,10 @@ To build the full tune examples
2220
-----------------------------------
2321
bower install
2422
npm run full-tune
23+
24+
Limitations
25+
-----------
26+
27+
* We rely on VexFlow's auto-beaming feature which doesn't always do the right thing with (for example) tuplets, depending on the key signature.
28+
* ABC's modified key signature (for defining non-classical modes as found in, for example, some klezmer scores) is not supported.
29+
* Grace notes are supported only against individual notes (not chords, tuplets etc.).

bower.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"purescript-prelude": "^4.1.0",
1111
"purescript-console": "^4.1.0",
1212
"purescript-effect": "^2.0.0",
13-
"purescript-abc-parser": "https://github.com/newlandsvalley/purescript-abc-parser.git#master"
13+
"purescript-abc-parser": "https://github.com/newlandsvalley/purescript-abc-parser.git#1.4.0"
1414
},
1515
"devDependencies": {
1616
"purescript-psci-support": "^4.0.0",

0 commit comments

Comments
 (0)