Documentation

Welcome to the Documentation.

Warning

The documentation is still work in progress!

This information is intended for developers of the project or for people who are interested in the technical details behind the project.

Project Structure

├───build  
│   └───exe  
├───scripts  
└───src  
    ├───app  
    │   ├───res  
    │   ├───win  
    ├───lang  
    │   └───build  
    └───ui  
        ├───components  
        ├───dialogs  
        ├───res  
        │   ├───png  
        │   └───svg  
        ├───tabs  
        ├───types  
        └───window  

The build directory contains all data that e.g. Pyinstaller creates including the final executable.
The scripts folder has all the .bat and .sh scripts to help with creating the translations and executable.
The src folder contains all the source data of the project:

• app houses all the custom Python modules, some Windows specific modules as well as general resources like the default settings file and the template database.
• lang contains everything related to the languages, including the compiled languages in the build subdirectory.
• ui has all the .qml files in it, defining all of the UI using the QML language and pictures used in the res subdirectory.

Note

This documentation follows the same structure.