mirror of https://github.com/YGGverse/Yoda.git
phpcomposergemini-protocolgeminismallwebaltwebgtk3browsergtkphp-gtkgemini-clientyoda-browserphp-cppgemini-browseryoda
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1.8 KiB
1.8 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
- Use modern path pattern
- 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:
- 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
) - implement only one
struct
(same as one file for one class)struct
is public, where members - private
- contain main
struct
implementation:- at least one constructor that must return:
- unwrapped main
Self
structure - granted ownership for new object created
- unwrapped main
- public link getter for privately constructed widget
- at least one constructor that must return:
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