|
Name |
|
Date |
Size |
#Lines |
LOC |
| .. | | 03-May-2022 | - |
| .github/ | H | 27-Jan-2021 | - | 704 | 650 |
| .tx/ | H | 27-Jan-2021 | - | 25 | 17 |
| .vscode/ | H | 27-Jan-2021 | - | 358 | 339 |
| aeolus/ | H | 03-May-2022 | - | 7,090 | 5,161 |
| assets/ | H | 03-May-2022 | - | | |
| audio/ | H | 03-May-2022 | - | 21,888 | 14,669 |
| audiofile/ | H | 03-May-2022 | - | 207 | 124 |
| avsomr/ | H | 03-May-2022 | - | 4,898 | 2,834 |
| awl/ | H | 03-May-2022 | - | 4,194 | 2,286 |
| build/ | H | 27-Jan-2021 | - | 9,115 | 7,206 |
| bww2mxml/ | H | 03-May-2022 | - | 16,511 | 16,129 |
| crashreporter/ | H | 03-May-2022 | - | 314 | 197 |
| demos/ | H | 03-May-2022 | - | 49,484 | 49,294 |
| doc/ | H | 27-Jan-2021 | - | 298 | 234 |
| effects/ | H | 03-May-2022 | - | 4,595 | 3,340 |
| fonts/ | H | 03-May-2022 | - | 986,121 | 957,458 |
| fonttools/ | H | 03-May-2022 | - | 972 | 754 |
| global/ | H | 03-May-2022 | - | 469 | 284 |
| importexport/ | H | 03-May-2022 | - | 69,336 | 51,679 |
| libmscore/ | H | 03-May-2022 | - | 175,217 | 127,537 |
| main/ | H | 03-May-2022 | - | 202 | 97 |
| miditools/ | H | 03-May-2022 | - | 1,737 | 1,169 |
| mscore/ | H | 03-May-2022 | - | 219,204 | 175,532 |
| mtest/ | H | 03-May-2022 | - | 1,252,982 | 1,244,191 |
| omr/ | H | 03-May-2022 | - | 4,510 | 3,024 |
| rdoc/ | H | 03-May-2022 | - | 97 | 85 |
| share/ | H | 03-May-2022 | - | 3,144,503 | 3,141,155 |
| telemetry/ | H | 03-May-2022 | - | 1,099 | 571 |
| test/ | H | 03-May-2022 | - | 123,438 | 122,462 |
| thirdparty/ | H | 27-Jan-2021 | - | 579,675 | 407,393 |
| vtest/ | H | 03-May-2022 | - | 138,506 | 138,106 |
| .appveyor_off.yml | H A D | 27-Jan-2021 | 2.3 KiB | 79 | 64 |
| .gitattributes | H A D | 27-Jan-2021 | 152 | 5 | 4 |
| .gitignore | H A D | 27-Jan-2021 | 705 | 55 | 53 |
| .gitmodules | H A D | 27-Jan-2021 | 144 | 4 | 3 |
| .travis.yml | H A D | 27-Jan-2021 | 4 KiB | 114 | 107 |
| CMakeSettings.json | H A D | 27-Jan-2021 | 1.3 KiB | 39 | 38 |
| Compatibility | H A D | 27-Jan-2021 | 369 | 11 | 7 |
| Doxyfile.plugins | H A D | 27-Jan-2021 | 107.1 KiB | 2,516 | 1,961 |
| LICENSE.GPL | H A D | 27-Jan-2021 | 18.9 KiB | 365 | 301 |
| Makefile | H A D | 27-Jan-2021 | 9 KiB | 227 | 150 |
| Makefile.mingw | H A D | 27-Jan-2021 | 2.1 KiB | 64 | 29 |
| Makefile.osx | H A D | 27-Jan-2021 | 4.8 KiB | 146 | 105 |
| README.md | H A D | 27-Jan-2021 | 5.7 KiB | 132 | 82 |
| all.cpp | H A D | 27-Jan-2021 | 998 | 23 | 0 |
| all.h | H A D | 03-May-2022 | 5.4 KiB | 237 | 184 |
| config.cmake | H A D | 27-Jan-2021 | 2 KiB | 48 | 42 |
| msvc_build.bat | H A D | 27-Jan-2021 | 7.8 KiB | 228 | 192 |
README.md
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