16 Home

Peter Jonas edited this page 2023-03-06 22:37:47 +00:00

Table of Contents

• Welcome to the MuseScore Project!

Welcome to the MuseScore Project!

This Wiki is the place to be if you want to compile MuseScore or assist with its development.

• View the sidebar to the right of this page for a full list of Wiki topics →
• On mobile the sidebar is displayed at the bottom of the page ↓

Newcomers should start by reading our Contributing page.

---

Occasionally, you may need to refer to our older documentation over on MuseScore.org. This includes the Developers' handbook, which is at some points slightly outdated, but which may still contain useful tips, including:

• Extensive per-platform instructions about building the 3.x branch, which may also help you in case of trouble building the master branch
• A suggested Git Workflow
• Information about Google Summer of Code
• Tips about IDE configuration

For information about other ways to contribute, see https://musescore.org/en/contribute. This page contains information about:

• User support
• Documentation of the MuseScore app
• Translating
• Testing
• Writing plugins

If you have questions, you are invited to join the official MuseScore Developers Discord Server.

• Home
• Contributing
• CodeGuidelines
• CodeStructure
• DocsGuidelines

Testing

• Manual testing
  • Manual testing overview
  • Downloading and running test builds
  • Autobot overview
  • TestCases 1-10
  • Functional requirements
  • Accessibility testing
  • Reporting bugs and issues
• Automatic testing
  • Unit Tests
  • Visual Tests

Translation

• Help translate MuseScore
• Translating instrument names

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
   • Compiling on Macs with Apple Silicon
6. Compile in Qt Creator

Beyond compiling

• Find your way around the code
• CMake and the build system
• Submit a Pull Request
• Fix the unit tests
• Uncrustify (Code Beautifier)

Architecture general

• Architecture overview
• AppShell
• Modularity
  • Dependency injection
• Interact workflow
  • Actions
  • UI Actions
  • Shortcuts
  • MIDI Remote Control
• Channels and Notifications
• Settings and Configuration
• Error handling
• Launcher and Interactive
• Keyboard Navigation

Audio

• Audio overview

Engraving

• Style settings
• Style Parameter changes between 3.6 and 4.0
• Style Parameter changes between 4.0 and 4.1
• Style Parameter changes between 4.1 and 4.2

References

• Resources

• Release process