MuseScore is an open source and free music notation software. For support, contribution, bug reports, visit MuseScore.org. Fork and make pull requests!
Go to file
Joachim Schmitz ce1cc9e167 Update .git-blame-ignore-revs
to include one more rev to ignore
2021-04-19 22:29:45 +02:00
.github Update issue templates 2021-03-10 19:59:02 +02:00
.tx Make tours translatable 2018-12-21 23:23:17 +01:00
.vscode removed aeolus 2020-12-02 16:22:33 +02:00
assets fix README musescore logo 2020-12-02 21:34:55 +02:00
build Updated license headers in .sh files 2021-04-19 17:10:01 +02:00
demos Updated license headers for cmake files 2021-04-19 17:09:37 +02:00
doc Update and add 1.x plugin documentation pages to Doxygen-based docs 2019-12-25 11:10:25 +02:00
fonts Refactor Playback Toolbar to use AbstractMenuModel and StyledMenu 2021-04-14 10:48:02 +02:00
hooks Updated license headers in .sh files 2021-04-19 17:10:01 +02:00
mtest Updated license headers in .sh files 2021-04-19 17:10:01 +02:00
rdoc Updated license headers for cmake files 2021-04-19 17:09:37 +02:00
sandbox/cpad Updated license headers for cmake files 2021-04-19 17:09:37 +02:00
share Updated license headers for cmake files 2021-04-19 17:09:37 +02:00
src renamed keynav to navigation 2021-04-19 18:49:19 +02:00
test removed aeolus 2020-12-02 16:22:33 +02:00
thirdparty Added license files for google_crash_pad cliend 2021-04-16 13:52:13 +03:00
tools Updated license headers in .sh files 2021-04-19 17:10:01 +02:00
vtest Updated license headers in .sh files 2021-04-19 17:10:01 +02:00
.git-blame-ignore-revs Update .git-blame-ignore-revs 2021-04-19 22:29:45 +02:00
.gitattributes ONE BUILD SCRIPT TO RULE THEM ALL! 2021-03-05 12:30:31 +02:00
.gitignore ONE BUILD SCRIPT TO RULE THEM ALL! 2021-03-05 12:30:31 +02:00
CMakeLists.txt Updated license headers for cmake files 2021-04-19 17:09:37 +02:00
CMakeSettings.json Switch to Microsoft Visual Studio 2019 2020-04-14 21:55:16 +02:00
Compatibility enhanced 1.2 import 2012-08-23 12:28:27 +02:00
Doxyfile.plugins fix #306551: expose SymId enumeration to plugins 2020-12-15 01:12:19 -06:00
LICENSE.GPL Updated main license file and readme 2021-04-16 13:52:13 +03:00
Makefile ONE BUILD SCRIPT TO RULE THEM ALL! 2021-03-05 12:30:31 +02:00
Makefile.mingw ONE BUILD SCRIPT TO RULE THEM ALL! 2021-03-05 12:30:31 +02:00
Makefile.osx ONE BUILD SCRIPT TO RULE THEM ALL! 2021-03-05 12:30:31 +02:00
README.md Updated main license file and readme 2021-04-16 13:52:13 +03:00
build.cmake ONE BUILD SCRIPT TO RULE THEM ALL! 2021-03-05 12:30:31 +02:00
config.cmake rework root cmake project 2020-12-05 12:04:43 +03:00
mscore3.txt fix various typos 2019-12-19 06:13:30 -05:00
msvc_build.bat fix msvc_build.bat to work again 2020-12-11 11:34:33 -06:00
ninja_build.bat added Windows CI build with ninja 2021-01-12 16:53:03 +02:00
ninja_build.sh Updated license headers in .sh files 2021-04-19 17:10:01 +02:00

README.md

MuseScore Music notation and composition software

License: GPL v3

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

Features

  • WYSIWYG design, notes are entered on a "virtual notepaper"
  • TrueType font(s) for printing & display allows for high quality scaling to all sizes
  • Easy & fast note entry
  • Many editing functions
  • MusicXML import/export
  • MIDI (SMF) import/export
  • MuseData import
  • MIDI input for note entry
  • Integrated sequencer and software synthesizer to play the score
  • Print or create pdf files

More info

License

MuseScore is licensed under GPL version 3.0. See LICENSE.GPL in the same directory.

Packages

See Code Structure on Wiki

Building

Read the developer handbook 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 https://github.com/musescore/MuseScore.git
cd MuseScore

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 for release, type:

cmake -P build.cmake -DCMAKE_BUILD_TYPE=Release

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, 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 mtest/README.md or the developer handbook for instructions on how to run the test suite.

The new script testing facility is also available to create your own automated tests. Please try it out!

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.