1![MuseScore](mscore/data/musescore_logo_full.png) 2Music notation and composition software 3 4[![Travis CI](https://secure.travis-ci.org/musescore/MuseScore.svg?branch=master)](https://travis-ci.org/musescore/MuseScore) 5[![Appveyor](https://ci.appveyor.com/api/projects/status/bp3ww6v985i64ece/branch/master?svg=true)](https://ci.appveyor.com/project/MuseScore/musescore/branch/master) 6[![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html) 7 8MuseScore is an open source and free music notation software. For support, contribution, and bug reports visit MuseScore.org. Fork and make pull requests! 9 10## Features 11 12- WYSIWYG design, notes are entered on a "virtual notepaper" 13- TrueType font(s) for printing & display allows for high quality scaling to all sizes 14- Easy & fast note entry 15- Many editing functions 16- MusicXML import/export 17- MIDI (SMF) import/export 18- MuseData import 19- MIDI input for note entry 20- Integrated sequencer and software synthesizer to play the score 21- Print or create pdf files 22 23## More info 24- [MuseScore Homepage](https://musescore.org) 25- [MuseScore Git workflow instructions](https://musescore.org/en/developers-handbook/git-workflow) 26- [How to compile MuseScore?](https://musescore.org/en/developers-handbook/compilation) 27 28## License 29MuseScore is licensed under GPL version 2.0. See [LICENSE.GPL](https://github.com/musescore/MuseScore/blob/master/LICENSE.GPL) in the same directory. 30 31## Packages 32- **aeolus:** Clone of [Aeolus](http://kokkinizita.linuxaudio.org/linuxaudio/aeolus/). Disabled by default in the stable releases. See http://dev-list.musescore.org/Aeolus-Organ-Synth-td7578364.html. Kept as an example of how to integrate with a complex synthesizer. 33 34- **assets:** Graphical assets, use them if you need a MuseScore icon. For logo, color, etc., see https://musescore.org/en/about/logos-and-graphics. 35 36- **awl:** Audio Widget Library, from the MusE project. 37 38- **build:** Utility files for build. 39 40- **bww2mxml:** Command line tool to convert BWW files to MusicXML. BWW parser is used by MuseScore to import BWW files. 41 42- **demos:** A few MuseScore files to demonstrate what can be done. 43 44- **fluid:** Clone of [FluidSynth@sourceforge](https://sourceforge.net/projects/fluidsynth), ported to C++ and customized. Code now at [fluidsynth@github](https://github.com/FluidSynth/fluidsynth). 45 46- **fonts:** Contains fontforge source (sfd) + ttf/otf fonts. MuseScore includes the "Emmentaler" font from the Lilypond project. 47 48- **libmscore:** Data model of MuseScore. 49 50- **mscore:** Main code for the MuseScore UI. 51 52- **msynth:** Abstract interface to Fluid + Aeolus. 53 54- **mtest:** Unit testing using QTest. 55 56- **omr:** Optical music recognition. 57 58- **share:** Files moved to /usr/share/... on install. 59 60- **test:** Old tests. Should move to mtest. 61 62- **vtest:** Visual tests. Compare reference images with current implementation. 63 64- **thirdparty:** Contains projects which are included for convenience, usually to integrate them into the build system to make them available for all supported platforms. 65 66 - **thirdparty/rtf2html:** 67 Used for capella import. Clone from [rtf2html@sourceforge](https://sourceforge.net/projects/rtf2html), code now at [rtf2html@github](https://github.com/lvu/rtf2html). 68 69 - **thirdparty/dtl:** 70 Used for the score comparison tool. [Diff Template Library](https://github.com/cubicdaiya/dtl). 71 72 - **thirdparty/ofqf:** 73 OSC server interface. Based on [OSC for Qt4](http://www.arnoldarts.de/projects/ofqf/), code now at [ofq@github](https://github.com/kampfschlaefer/ofq). 74 75 - **thirdparty/singleapp:** 76 Clone from [Qt Single Application](https://github.com/qtproject/qt-solutions/tree/master/qtsingleapplication). 77 78 - **thirdparty/portmidi:** 79 Clone from [PortMidi](https://sourceforge.net/projects/portmedia/). 80 81 - **thirdparty/beatroot:** 82 It's a core part of [BeatRoot Vamp Plugin](https://code.soundsoftware.ac.uk/projects/beatroot-vamp/repository) by Simon Dixon and Chris Cannam, used in MIDI import for beat detection. 83 84 - **thirdparty/qt-google-analytics:** 85 Clone from [qt-google-analytics](https://github.com/HSAnet/qt-google-analytics). 86 87 88## Building 89**Read the developer handbook for a [complete build walkthrough](https://musescore.org/en/developers-handbook/compilation) and a list of dependencies.** 90 91### Getting sources 92If using git to download repo of entire code history, type: 93 94 git clone https://github.com/musescore/MuseScore.git 95 cd MuseScore 96 97Otherwise, you can just download the latest source release tarball from the [Releases page](https://github.com/musescore/MuseScore/releases), and then from your download directory type: 98 99 tar xzf MuseScore-x.x.x.tar.gz 100 cd MuseScore-x.x.x 101 102### Release Build 103To compile MuseScore, type: 104 105 make release 106 107If something goes wrong, then remove the whole build subdirectory with `make clean` and start new with `make release`. 108 109### Running 110To start MuseScore, type: 111 112 ./build.release/mscore/mscore 113 114The Start Center window will appear on every invocation until you disable that setting via the "Preferences" dialog. 115 116### Installing 117To install to default prefix using root user, type: 118 119 sudo make install 120 121### Debug Build 122A debug version can be built by doing `make debug` instead of `make release`. 123 124To run the debug version, type: 125 126 ./build.debug/mscore/mscore 127 128### Testing 129See [mtest/README.md](/mtest/README.md) or [the developer handbook](https://musescore.org/handbook/developers-handbook/finding-your-way-around/automated-tests) for instructions on how to run the test suite. 130 131The new [script testing facility](https://musescore.org/node/278278) is also available to create your own automated tests. Please try it out! 132