mirror of
https://github.com/YGGverse/Yoda.git
synced 2025-01-15 09:10:08 +00:00
1.5 KiB
1.5 KiB
Yoda - Browser for Gemini protocol
Rust / GTK 4 implementation
Important
Project in development!
Install
Stable
cargo install Yoda
Repository
git clone https://github.com/YGGverse/Yoda.git
cd Yoda
git checkout Rust-GTK4
cargo run
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
- 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
) - One mod = one widget. Create new mod for new widget implementation
- Mod constructor must return Arc pointer for new object created (to support async operations)
Contribution
- before commit, make sure:
- new branch created for every new PR
git checkout -b 'contribution-name'
- new code follows common rustfmt style
cargo fmt --check
- new branch created for every new PR