Contribute¶
First of all, thank you for your interest in the app. Schim started out of the frustration with the limitations that proprietary software imposes on its users. So there you go: in Schim you can customize literally anything.
Overview¶
Schim is made up of multiple repositories:
- Schim
This is the main code repository. It contains everything that is necessary to compile and install Schim.
- Schim documentation
This is where Schim's complete documentation resides. You are reading it right now!
- Schim extras
This is the cherry on top of the cake. It contains anything that can be used to enhance the user experience, but which is not part of the application. This includes configuration files for shells, syntax for text editors and more sweet stuff.
- Schim assets
All promotional and educational material lives here. This includes posters, videos, tutorials, etc.
For users¶
Schim strives to be as user friendly as possible. That is why we rely on your help. Any feedback is appreciated. The following are the most common ways you can contribute:
Propose a new feature¶
If you have any ideas for new features, create an issue on GitHub. TODO details
Report a bug¶
Fixing bugs is a priority for us. So please, if anything bothers you, contact us and we will fix it pronto.
Help us build a library of symbols¶
If there is a standard component that is missing in Schim, you can add it.
Propose a design improvement¶
We want Schim look modern. If you have an idea to improve the design of Schim, you can get in touch with us. Send us a sketch, we'll review it and get to work if we think you're onto something. You can also implement that design improvement if you feel so inclined.
Tutorials¶
If you have good presentational skills and want to show of your recording equipment, you can get in touch with us to make educational material for Schim.
Additional things¶
Have a look at our assets repository.
The main ways you can contribute are:
Todo
add...
If you decide to develop code for this project, the Developer Documentation is a useful resource. It is written in great detail. It also makes Schim a useful first project for beginners.