gtk-rs / gir

Tool to generate rust bindings and user API for glib-based libraries
https://gtk-rs.org/gir/book/
MIT License
230 stars 102 forks source link

gir tutorial needs some improvements #1199

Open sdroege opened 4 years ago

sdroege commented 4 years ago
  1. It should apparently be made more clear that Cargo.toml and src/lib.rs at least have to be manually written, and that there should also be a prelude module re-exporting all traits
  2. bitflags and once_cell / lazy_static should be added as crate dependencies as needed
  3. The part about the initialization macros is not clear. When are they needed, what should they do, when can they be disabled.
  4. Make it clear that the same versions of the dependency crates (glib etc) is needed and versions can't be mixed, especially not from git and crates.io
  5. Add something that functions/signals not being generated usually means that some types are missing and have to be generated too, and that details can be found in the commented out declaration of the function that is put into src/auto

CC @GuillaumeGomez

sophie-h commented 3 years ago

Probably move to gtk-rs/gir if this still applies? cc @bilelmoussaoui

GuillaumeGomez commented 3 years ago

Moving the issue.