Skip to content

Commit b161909

Browse files
Update README to mention the new dependencies on music21 8.2 and converter21 2.0.
1 parent 8071154 commit b161909

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ musicdiff is derived from: [music-score-diff](https://github.com/fosfrancesco/mu
77
by [Francesco Foscarin](https://github.com/fosfrancesco).
88

99
## Setup
10-
Depends on [music21](https://pypi.org/project/music21) (version 7.2+), [numpy](https://pypi.org/project/numpy), and [converter21](https://pypi.org/project/converter21). You also will need to configure music21 (instructions [here](https://web.mit.edu/music21/doc/usersGuide/usersGuide_01_installing.html)) to display a musical score (e.g. with MuseScore).
10+
Depends on [music21](https://pypi.org/project/music21) (version 8.2+), [numpy](https://pypi.org/project/numpy), and [converter21](https://pypi.org/project/converter21) (version 2.0+). You also will need to configure music21 (instructions [here](https://web.mit.edu/music21/doc/usersGuide/usersGuide_01_installing.html)) to display a musical score (e.g. with MuseScore).
1111

1212
## Usage
1313
On the command line:
@@ -22,7 +22,7 @@ The source for that command-line tool, which calls musicdiff's high-level diff()
2222

2323
A google colab notebook is available [here](examples/musicdiff_demo.ipynb).
2424

25-
If you are interested in calling lower-level musicdiff APIs to do more complicated things than just visualization in PDFs, the source for musicdiff's high-level diff() API (found [here](musicdiff/__init__.py)) is good example code to read.
25+
If you are interested in calling lower-level musicdiff APIs to do more complicated things than just visualization in PDFs, the source for musicdiff's high-level diff() API (found [here](musicdiff/__init__.py)) is good example code to read. Note particularly how diff() calls converter21.register() to register converter21's Humdrum and MEI parsers for use by music21. If you call lower-level APIs than diff(), you will need to do this yourself.
2626

2727
## Documentation
2828
You can find the musicdiff API documentation [here](https://gregchapman-dev.github.io/musicdiff).

pypi_README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ musicdiff is derived from: [music-score-diff](https://github.com/fosfrancesco/mu
77
by [Francesco Foscarin](https://github.com/fosfrancesco).
88

99
## Setup
10-
Depends on [music21](https://pypi.org/project/music21) (version 7.2+), [numpy](https://pypi.org/project/numpy), and [converter21](https://pypi.org/project/converter21). You also will need to configure music21 (instructions [here](https://web.mit.edu/music21/doc/usersGuide/usersGuide_01_installing.html)) to display a musical score (e.g. with MuseScore).
10+
Depends on [music21](https://pypi.org/project/music21) (version 8.2+), [numpy](https://pypi.org/project/numpy), and [converter21](https://pypi.org/project/converter21) (version 2.0+). You also will need to configure music21 (instructions [here](https://web.mit.edu/music21/doc/usersGuide/usersGuide_01_installing.html)) to display a musical score (e.g. with MuseScore).
1111

1212
## Usage
1313
On the command line:

0 commit comments

Comments
 (0)