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
Casper Jeukendrup 04bb125b93 Remove some things 2023-05-06 17:57:52 +02:00
.github Two in one 2023-05-05 23:30:33 +02:00
.tx Add the "instruments" resource to .tx/config 2022-07-30 03:56:19 +02:00
.vscode removed aeolus 2020-12-02 16:22:33 +02:00
build Remove some things 2023-05-06 17:57:52 +02:00
demos updated tests and templates mscx files 2021-12-16 11:46:22 +03:00
doc doc: fixed some typos in plugins.md 2023-03-28 22:34:13 +03:00
fonts A deep overhaul of dynamics and expression 2023-04-28 16:27:43 +02:00
hooks Uncrustify: Faster pre-commit hook to fix code style 2023-04-10 12:52:37 +01:00
sandbox removed config.h 2023-02-14 15:51:40 +02:00
share Merge pull request #16172 from Jojo-Schmitz/note_names 2023-04-29 12:47:08 +02:00
src Add some test about throwing and catching exceptions 2023-05-05 23:18:15 +02:00
test Spelling (#11566) 2022-05-15 16:35:32 +02:00
thirdparty Fix compilation error with GCC 13 2023-03-20 07:52:06 -05:00
tools Check for translation errors when generating placeholder translations 2023-04-12 17:12:11 +01:00
vtest Merge pull request #17237 from mike-spa/clefsAndKeySigPositioning 2023-05-01 18:15:43 +03: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 added required modules for vtest (old) configuration 2023-03-14 06:59:23 -05:00
CMakeLists.txt added build option MUE_ENABLE_STRING_DEBUG_HACK 2023-05-03 15:27:52 +03:00
CMakeSettings.json renamed some cmake project options 2023-02-14 15:51:40 +02:00
CONTRIBUTING.md fix #124416: Add Contributing.md 2021-05-13 16:18:43 +01:00
Compatibility enhanced 1.2 import 2012-08-23 12:28:27 +02:00
Doxyfile.plugins Spelling (#11566) 2022-05-15 16:35:32 +02:00
LICENSE.GPL Updating copyright to 2023 2023-01-05 19:20:47 +01:00
README.md Updated compilation instruction links 2023-03-17 08:05:38 -05:00
SetupConfigure.cmake CI: enable asan for vtests and utests 2023-04-23 17:15:51 +02:00
build.cmake renamed some cmake project options 2023-02-14 15:51:40 +02:00
mscore3.txt Spelling (#11566) 2022-05-15 16:35:32 +02:00
msvc_build.bat removed config.h 2023-02-14 15:51:40 +02:00
ninja_build.bat added Windows CI build with ninja 2021-01-12 16:53:03 +02:00
ninja_build.sh Verbose build log 2023-05-05 23:18:15 +02:00
version.cmake removed config.h 2023-02-14 15:51:40 +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 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 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.