From 814642ff2fd92a6a731952b7cc58b427868fa9fe Mon Sep 17 00:00:00 2001 From: yggverse Date: Fri, 27 Sep 2024 23:00:20 +0300 Subject: [PATCH] update readme --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3bf9b698..41ae0ff8 100644 --- a/README.md +++ b/README.md @@ -25,22 +25,25 @@ cargo run ## 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) * 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 -* 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 * massive structures * structures with implementation * Every module must: - * encapsulate: compose childs and stay composable for parents - * access 1 level of child API, never parents (e.g. through `super`) + * encapsulate it members: compose childs and stay composable for parents + * access 1 level of childs, never parents (e.g. through `super`) * implement only one `struct` (same as one file for one class) * implementable `struct` is public, where members - private * contain main `struct` implementation: