From 355cdb9bf55e20959eb33a7c21010e8a334e8df5 Mon Sep 17 00:00:00 2001 From: Eberhard Wolff Date: Sun, 15 Jan 2023 16:26:46 +0100 Subject: [PATCH] Better documentation how to get started --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 603deba..0a6a300 100644 --- a/README.md +++ b/README.md @@ -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