Contributing
If you want to help the project grow, there are a few options waiting for you:
- Help found the developer
via In-App purchases or donations - this financially help us, and every even small contribution is more than welcome! - Translate the app's strings to your language
With every update new phrases are introduced, so there is always work to be done!
- Enhance the documentation
When you become an expert in using the app, chances are you will note some shortages in this documentation. We encourage you to submit a pull request to the documentation repository when you feel you have something to add that could benefit others!
Testing the documentation
If you want to edit and test the documentation prior to committing, there are a few easy steps to get you started.
Below are outlined the main steps, but feel free to follow the MkDocs documentation or Material for MkDocs.
- Install Python 3+. Python 2.7 will not work.
- Install
pip
:pip install --upgrade pip
- Install Material for MkDocs via
pip install mkdocs-material
- Clone the repository locally to a folder on your system.
- Edit the files. Once finished, run in the base folder (the one containing
mkdocs.yml
):mkdocs serve
- See the edited site at
127.0.0.1:8000