Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better documentation how to get started #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Better documentation how to get started #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,17 @@
# music21-melodies
Using the python library music21

## Requirements

* [Musescore](https://musescore.org/)
* Python 3.10, see [Python downloads](https://www.python.org/downloads/). You can try a different version of Python, change the [Pipfile](Pipfile) acccordingly.
* [pip](https://pip.pypa.io/en/stable/getting-started/)
* [pipenv](https://pipenv.pypa.io/en/latest/#install-pipenv-today)
* Install the needed packages `pipenv install`
* Configure music21
* [Original documentation](https://web.mit.edu/music21/doc/usersGuide/usersGuide_01_installing.html)
* However, this project runs in a virtual Python environment. So you have to do it differently. Run the installation in the virtual environment: `pipenv run python -m music21.configure`
* This might actually be quite slow to start.
* You should configure Musescore as an XML reader.
* Run the Jupyter notebook: `pipenv run jupyter notebook`. A browser should open and you should be good to go.
* At the top, you have to select that you trust the notebook. Otherwise it is unable to run Muse