2013-09-30 10:14:15 +02:00
# MuseScore: Music notation and composition software
## 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
2013-01-24 15:08:09 +01:00
* [MuseScore Homepage ](http://musescore.org )
* [MuseScore Git workflow instructions ](http://musescore.org/en/developers-handbook/git-workflow ).
2013-09-30 10:14:15 +02:00
* [How to compile MuseScore? ](http://musescore.org/en/developers-handbook/compilation )
2013-01-24 15:08:09 +01:00
* Build status: [](http://travis-ci.org/musescore/MuseScore)
2012-05-28 11:04:58 +02:00
2013-09-30 10:14:15 +02:00
## License
MuseScore is licensed under GPL version 2.0. See LICENSE.GPL in the same directory.
## Packages
2013-09-28 11:19:51 +02:00
* **aeolus** Clone of [Aeolus ](http://kokkinizita.linuxaudio.org/linuxaudio/aeolus/ )
2014-08-12 22:34:44 +02:00
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.
2012-05-28 11:04:58 +02:00
2015-03-21 10:21:22 +01:00
* **assets** Graphical assets, use them if you need a MuseScore icon. For logo, color etc... see http://musescore.org/en/about/logos-and-graphics
2012-05-28 11:04:58 +02:00
* **awl** Audio Widget Library, from the MusE project
* **build** Utility files for build
* **bww2mxml** Command line tool to convert BWW files to MusicXML. BWW parser is used by MuseScore to import BWW files.
* **demos** A few MuseScore files to demonstrate what can be done
2012-06-04 21:06:12 +02:00
2012-05-28 11:04:58 +02:00
* **fluid** Clone of [FluidSynth ](http://sourceforge.net/apps/trac/fluidsynth/ ), ported to C++ and customized
2013-09-30 10:14:15 +02:00
* **fonts** Contains fontforge source (sfd) + ttf/otf fonts. MuseScore includes the "Emmentaler" font from the Lilypond project.
2012-05-28 11:04:58 +02:00
2013-08-13 16:38:48 +02:00
* **libmscore** Data model of MuseScore
2012-05-28 11:04:58 +02:00
* **mscore** Main code for the MuseScore UI
2012-06-04 21:06:12 +02:00
2012-05-28 11:04:58 +02:00
* **mstyle** Clone of KDE4 style Oxygen
2012-06-04 21:06:12 +02:00
2012-05-28 11:04:58 +02:00
* **msynth** Abstract interface to Fluid + Aeolus
* **mtest** Unit testing using QTest
* **omr** Optical music recognition
* **share** Files moved to /usr/share/... on install
* **test** Old tests. Should move to mtest
2013-09-28 11:19:51 +02:00
* **vtest** Visual tests. Compare reference images with current implementation
2012-05-28 11:04:58 +02:00
* **thirdparty** Contains projects which are included for convenience, usually to integrate them into the build system to make them available for all supported platforms.
* **thirdparty/rtf2html**
Used for capella import
* **thirdparty/diff**
Not used currently. [Diff, Match and Patch Library ](http://code.google.com/p/google-diff-match-patch/ )
* **thirdparty/ofqf**
2014-04-30 08:19:32 +02:00
OSC server interface. Based on [OSC for Qt4 ](http://www.arnoldarts.de/ofqf.html )
2012-05-28 11:04:58 +02:00
* **thirdparty/singleapp**
Clone from [Qt Single Application ](http://qt.gitorious.org/qt-solutions/qt-solutions/trees/master/qtsingleapplication )
2014-07-23 12:57:06 +02:00
* **thirdparty/portmidi**
Clone from [PortMidi ](http://portmedia.sourceforge.net/ )
* **thirdparty/beatroot**
It's a core part of BeatRoot Vamp Plugin by Simon Dixon and Chris Cannam,
used in MIDI import for beat detection. (http://code.soundsoftware.ac.uk/projects/beatroot-vamp/repository)
2013-09-30 10:14:15 +02:00
## Installation
**Read the developer handbook for a [complete build walkthrough ](http://musescore.org/en/developers-handbook/compilation ) and a list of dependencies.**
* unpack source distribution
2013-12-31 10:52:04 +01:00
2013-09-30 10:14:15 +02:00
tar xvofj mscore-x.x.x.tar.bz2
* make
2013-12-31 10:52:04 +01:00
2013-09-30 10:14:15 +02:00
cd mscore-x.x.x
make release
if something goes wrong, then remove the whole build subdirectory with `make clean` and start new with `make release`
* install as root user
2013-12-31 10:52:04 +01:00
2013-09-30 10:14:15 +02:00
sudo make install
### Program Documentation
To generate the program documentation with DoxyGen, type
cd build
make doxy
Browse the documentation with your favourite html browser at build/Doc/html/index.html
### Run
cd build.release/mscore
./mscore
to start MuseScore. On first invocation a demofile is shown. You probably want to change that in the "Preferences" dialog.
### Debug
A debug version can be built by doing `make debug` above, instead of `make release` .
To test the debug version, type
cd build.debug/mscore
./mscore
