MuseScore README

The project's README from github.com/musescore/MuseScore. As one markdown file: README.md.

MuseScore Studio

Music notation and composition software

License: GPL v3 Coverage

MuseScore Studio is an open source and free music notation software. For support, contribution, and bug reports visit MuseScore.org. Fork and make pull requests!

Features

More info

License

MuseScore Studio is licensed under GPL version 3.0. See license file in the same directory.

Packages

See Code Structure on Wiki

Building

Read the Compilation section of the MuseScore Wiki for a complete build walkthrough and a list of dependencies.

Getting sources

If using git to download repo of entire code history, type:

git clone  --recurse-submodules https://github.com/musescore/MuseScore.git
cd MuseScore

(The --recurse-submodules ensures that the muse_framework git submodule is checked out into the muse/ subdirectory.)

Otherwise, you can just download the latest source release tarball from the Releases page, and then from your download directory type:

tar xzf MuseScore-x.x.x.tar.gz
cd MuseScore-x.x.x

Release Build

To compile MuseScore Studio for release, type:

cmake -P build.cmake -DCMAKE_BUILD_TYPE=Release

On MacOS, append -G Ninja in order to use the ninja build tool (which you may need to install), since this is required to compile Swift components.

If something goes wrong, append the word "clean" to the above command to delete the build subdirectory:

cmake -P build.cmake -DCMAKE_BUILD_TYPE=Release clean

Then try running the first command again.

Running

To start MuseScore Studio, type:

cmake -P build.cmake -DCMAKE_BUILD_TYPE=Release run

Or run the compiled executable directly.

Debug Build

A debug version can be built and run by replacing -DCMAKE_BUILD_TYPE=Release with -DCMAKE_BUILD_TYPE=Debug in the above commands.

If you omit the -DCMAKE_BUILD_TYPE option entirely then RelWithDebInfo is used by default, as it provides a useful compromise between Release and Debug.

Testing

See the Unit tests section of the MuseScore Studio Wiki for instructions on how to run the test suite.

Code Formatting

Run ./hooks/install.sh to install a pre-commit hook that will format your staged files. Requires that you install uncrustify.

If you have problems, please report them. To uninstall, run ./hooks/uninstall.sh.

MuseScore (musescore/MuseScore)

Searching Database…

15.3K ·GitHub
MuseScore
What is this?MuseScore is a free and open-source music notation (sheet music) software for writing, editing, and printing scores.
Is this a notation editor or a full digital audio workstation?It's a WYSIWYG music notation editor: you enter notes on a virtual notepaper and it handles layout, playback, and export, not multitrack audio production.
What do I need installed before compiling?You need the dependencies listed in the MuseScore Wiki's Compilation section, plus Ninja on macOS specifically to compile the Swift components.
Is this just a quick build, or more involved?Building from source requires following a full dependency walkthrough on the Wiki rather than a one-command install; most users should instead get a prebuilt release.
Which platforms can I run it on?MuseScore builds on Linux, macOS, and Windows, and the project also has a WebAssembly build pipeline.
Can I import or export MusicXML and MIDI files?Yes, it supports MusicXML import/export, MIDI (SMF) import/export, MEI import/export, and MuseData import.
Can I play back my score or just view it?MuseScore includes an integrated sequencer and software synthesizer so you can hear your score played back, and you can print it or export it as a PDF.
What is SFZ doing in the topics list?MuseScore uses SFZ-format soundfonts for its built-in playback synthesizer.
How do I run the test suite?The Unit tests section of the MuseScore Studio Wiki explains how to run the project's test suite.
What are similar projects?wordcraft, moonlight-qt, Sourcetrail, shotcut, PrismLauncher, rembrandt, qutebrowser, Gource
Which topics is it in?wysiwyg, qt, music, workflow, wasm, git, pdf, cpp, c++, gplv3, desktop-app, web
Creator
musescore
Size
1.3 GB
Stars
15.3K
Updated
CommitOct 16Releasev4.7.5Sep 08
Age
14y
Commits · 90 Days