YGGverse/Yoda
1
0
Fork 0
mirror of https://github.com/YGGverse/Yoda.git synced 2025-01-29 20:44:25 +00:00
Code Issues Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
yggverse 2024-09-09 08:33:48 +03:00
parent 3f4a5536ca
commit f64b8d3f96
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -44,6 +44,17 @@ apt install git\
## Development
### Structure
Application sources located at `src/app` folder, by following basic principles:
* Every file extends one of GTK 4 Widgets according to subject (e.g. `class Browser : public Gtk::ApplicationWindow`)
* `src/app` does not contain other class entities like models or libraries (another folders and namespaces at `src` root are reserved for these needs)
* Every file work with it own, 1th level child only, to prevent massive logic levels keeping in mind
* To access any children features, deeper or higher than 1th level of current class, use delegation methods (actions, getters and setters)
* One file - one class. If the file requires additional (GTK) component, this component should be placed at similar folder with same name as parent filename. So we have simple hierarchy navigation logic - from app to window, from window to it container, etc.
* At this moment, all constants named with uppercase, const everything that not mutable
### Environment
``` bash