Skip to content

CodeStructure

Jump to bottom Edit New page
Max Reilly edited this page Jan 14, 2023 · 6 revisions

Code structure

Root

  • .github: Issue templates and github workflows.

  • .tx: Transifex configuration files.

  • .vscode: Configuration jsons for editing in Visual Studio Code.

  • build: Tools, scripts, and resources files for a build.

  • demos: A few MuseScore files to demonstrate what can be done.

  • doc: Markdown files containing useful information for making plugins, tick lengths, etc.

  • fonts: Contains fontforge source (sfd) + ttf/otf fonts.

  • hooks: Scripts for installation, pre-commit processing, and uninstallation.

  • mtest: Unit test suite, including a very detailed README that discusses setup and process.

  • sandbox: Test directory for isolating untested code changes and experimentation from the main project.

  • share: Files moved to /usr/share/... on install.

  • src: Source files.

  • test: A testing suite, largely deprecated.

  • thirdparty: Contains projects which are included for convenience, usually to integrate them into the build system to make them available for all supported platforms.

  • tools: Different tools.

  • vtest: Visual test scripts and resources. Compare reference with the current implementation.

Add a custom footer

Testing

Translation

Compilation

  1. Set up developer environment
  2. Install Qt and Qt Creator
  3. Get MuseScore's source code
  4. Install dependencies
  5. Compile on the command line
  6. Compile in Qt Creator

Beyond compiling

  1. Find your way around the code
  2. Submit a Pull Request
  3. Fix the CI checks

Architecture

Misc. development

Audio

Engraving

Extensions

Google Summer of Code

References

Clone this wiki locally