Introduction
Thanks for considering contributing to Piano Video!
As outlined in the plan, Piano Video comes in three sections:
Documentation on the sections can be found in their respective pages.
General
Most typo or bug fixes are accepted. If you propose an incompatible API change or a major feature, please discuss with me first.
Do not make patches for Windows or MacOS support. I will not support malware in this project. If you would like Windows or MacOS support, please fork the project and edit your own copy.
To start working on a task, please either look through the projects or issues on GitHub and choose one that interests you.
File Structure
The Piano Video repository contains these folders:
Path |
Description |
|---|---|
|
GitHub workflows for testing. |
|
Build scripts for |
|
Documentation (mainly Sphinx). |
|
Example MIDI and videos. They are licensed as CC0. |
|
Source code. Contains a few subdirectories. |
|
API source code. |
|
GUI source code. |
|
Kernel source code. |
|
Testing scripts. |