mirror of https://github.com/YGGverse/Yoda.git
phpcomposergeminigemini-protocolsmallwebaltwebyodagtk3browsergtkphp-gtkgemini-clientyoda-browserphp-cppgemini-browser
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.
yggverse
814642ff2f
|
2 months ago | |
---|---|---|
src | ||
.gitignore | ||
Cargo.toml | ||
LICENSE | ||
README.md | 2 months ago | |
rustfmt.toml |
README.md
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
Guide and protocol draft
browser
Filesystem
- 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
Codebase
- The codebase must be as minimal as possible, separate:
- different tasks
- massive structures
- structures with implementation
- Every module must:
- 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
- implementable
- 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