1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
# MuseScore: Music notation and composition software
MuseScore is an open source and free music notation software.
For support, contribution, bug reports, visit [MuseScore.org](https://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
* [MuseScore Homepage](https://musescore.org)
* [MuseScore Git workflow instructions](https://musescore.org/en/developers-handbook/git-workflow).
* [How to compile MuseScore?](https://musescore.org/en/developers-handbook/compilation)
* Build status: [](https://travis-ci.org/musescore/MuseScore)
## License
MuseScore is licensed under GPL version 2.0. See LICENSE.GPL in the same directory.
## Packages
* **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.
* **assets** Graphical assets, use them if you need a MuseScore icon. For logo, color etc... see https://musescore.org/en/about/logos-and-graphics
* **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
* **fluid** Clone of [FluidSynth](https://sourceforge.net/projects/fluidsynth/), ported to C++ and customized
* **fonts** Contains fontforge source (sfd) + ttf/otf fonts. MuseScore includes the "Emmentaler" font from the Lilypond project.
* **libmscore** Data model of MuseScore
* **mscore** Main code for the MuseScore UI
* **mstyle** Clone of KDE4 style Oxygen
* **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
* **vtest** Visual tests. Compare reference images with current implementation
* **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](https://code.google.com/p/google-diff-match-patch/)
* **thirdparty/ofqf**
OSC server interface. Based on [OSC for Qt4](http://www.arnoldarts.de/projects/ofqf/)
* **thirdparty/singleapp**
Clone from [Qt Single Application](https://github.com/qtproject/qt-solutions/tree/master/qtsingleapplication)
* **thirdparty/portmidi**
Clone from [PortMidi](https://sourceforge.net/projects/portmedia/)
* **thirdparty/beatroot**
It's a core part of BeatRoot Vamp Plugin by Simon Dixon and Chris Cannam,
used in MIDI import for beat detection. (https://code.soundsoftware.ac.uk/projects/beatroot-vamp/repository)
## Building
**Read the developer handbook for a [complete build walkthrough](https://musescore.org/en/developers-handbook/compilation) 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
Else can just download the latest source release tarball from https://github.com/musescore/MuseScore/releases, 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, type:
make release
If something goes wrong, then remove the whole build subdirectory with `make clean` and start new with `make release`.
### Running
To start MuseScore, type:
./build.release/mscore/mscore
The Start Center window will appear on every invocation, until you disable that setting via the "Preferences" dialog.
### Installing
To install to default prefix using root user, type:
sudo make install
### Debug Build
A debug version can be built by doing `make debug` instead of `make release`.
To run the debug version, type:
./build.debug/mscore/mscore
### Testing
See [mtest/README.md](/mtest/README.md) or https://musescore.org/en/developers-handbook/testing for instructions on how to run the test suite.
### Program Documentation
To generate program documentation using DoxyGen, first do `make debug`, then type:
make doxy
Browse the documentation in subdirectory Doc/html/index.html using any html browser.
|
