Contributing to HandWriter

HandWriter is a project that is still in its infancy. It has successfully delivered on its basic premise, but many improvements are still desired.
This documentation aims to make the HandWriter codebase easy to understand so that contributors may suitably modify it to deliver these improvements.

Technologies Used

• Python
• PyQt5 - Used to write the desktop GUI
• fman-build-system (FBS) - Used with PyQt5 to write the desktop GUI, and for packaging and distribution. Refer to their documentation here.

FBS critically requires Python 3.5 or 3.6, and PyInstaller 3.4
In fact, the whole project layout is based on FBS. To execute the app, type fbs run anywhere in the project.

Documentation layout

You can read more about the architecture here
Or about feeding a new handwriting (or automating handwriting generation) here