YGGverse/Yoda
1
0
Fork 0
mirror of https://github.com/YGGverse/Yoda.git synced 2025-02-10 10:24:13 +00:00
Code Issues Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
yggverse 2024-09-27 23:00:20 +03:00
parent ada426aae6
commit 814642ff2f
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -25,22 +25,25 @@ cargo run
## Development ## Development
This guide in process Guide and protocol draft
### Modules ### `browser`
#### `browser` #### Filesystem
* Use [modern path pattern](https://doc.rust-lang.org/edition-guide/rust-2018/path-changes.html#no-more-modrs) * Use [modern path pattern](https://doc.rust-lang.org/edition-guide/rust-2018/path-changes.html#no-more-modrs)
* One module implements one GTK widget, it may include additional helper files in same location (like template, CSS or DB API) * One module implements one GTK widget, it may include additional helper files in same location (like template, CSS or DB API)
* For children widget - create children module, located according to hierarchy * For children widget - create children module, located according to hierarchy
* The codebase of module must be as minimal as possible, separate to sub-modules:
#### Codebase
* The codebase must be as minimal as possible, separate:
* different tasks * different tasks
* massive structures * massive structures
* structures with implementation * structures with implementation
* Every module must: * Every module must:
* encapsulate: compose childs and stay composable for parents * encapsulate it members: compose childs and stay composable for parents
* access 1 level of child API, never parents (e.g. through `super`) * access 1 level of childs, never parents (e.g. through `super`)
* implement only one `struct` (same as one file for one class) * implement only one `struct` (same as one file for one class)
* implementable `struct` is public, where members - private * implementable `struct` is public, where members - private
* contain main `struct` implementation: * contain main `struct` implementation: