YGGverse/Yoda
1
0
Fork 0
mirror of https://github.com/YGGverse/Yoda.git synced 2025-03-13 06:01:21 +00:00
Code Issues Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
yggverse 2024-09-23 14:26:24 +03:00
parent 3d44bcb754
commit 6eeeef1ebf
1 changed files with 23 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -14,17 +14,36 @@ Rust / GTK 4 implementation
cargo install Yoda cargo install Yoda
``` ```
### Development ### Repository
``` bash ``` bash
git clone https://github.com/YGGverse/Yoda.git git clone https://github.com/YGGverse/Yoda.git
cd Yoda cd Yoda
git checkout Rust-GTK4 git checkout Rust-GTK4
git checkout -b 'contribution-name' cargo run
cargo fmt --check
cargo build
``` ```
## Development
This guide in process
### Modules
#### `browser`
* Main file must have `mod.rs` name because it may include additional submodules in same location like database, template, etc
* The codebase of module must be as minimal as possible: separate different tasks to submodules in same folder
* Every module or it helper must contain and implement only one `struct`
* 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`)
* Mod constructor must return [Arc pointer](https://doc.rust-lang.org/std/sync/struct.Arc.html) for new object created
### Contribution
* before commit, make sure:
* new branch created for every new PR `git checkout -b 'contribution-name'`
* new code follows common [rustfmt](https://rust-lang.github.io/rustfmt/) style `cargo fmt --check`
## See also ## See also
* [CPP-GTK4](https://github.com/YGGverse/Yoda/tree/CPP-GTK4) - C++ / GTK 4 implementation * [CPP-GTK4](https://github.com/YGGverse/Yoda/tree/CPP-GTK4) - C++ / GTK 4 implementation