From 4fea2ce7297e40f77ae819b87c8830dd925aacbe Mon Sep 17 00:00:00 2001 From: yggverse Date: Thu, 26 Sep 2024 00:29:08 +0300 Subject: [PATCH] update readme --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2e18dd83..e4ed3cc1 100644 --- a/README.md +++ b/README.md @@ -31,12 +31,21 @@ This guide in process #### `browser` -* The codebase of module must be as minimal as possible: separate different tasks to submodules -* Every module must implement only one `struct` (same as one file for one class) -* Composition modules (like box for window) stored in sub-folders and following same principles as parent -* Every mod access 1 level of child API, never parents (e.g.`super`) +##### Filesystem + +* Composition pattern, using standard `mod.rs` model * One mod = one widget. Create new mod for new widget implementation +##### Codebase + +* The codebase of module must be as minimal as possible: separate different tasks to submodules +* Every module must: + * implement only one `struct` (same as one file for one class) + * provide at least: + * one constructor that must: + * return raw `struct` without cover to any kind of smart `std` or `glib` pointers + * access 1 level of child API, never parents (e.g.`super`) + ### Contribution * before commit, make sure: