antoyo / relm

Idiomatic, GTK+-based, GUI library, inspired by Elm, written in Rust
MIT License
2.43k stars 78 forks source link

Lack of basic documentation #255

Closed alexxbb closed 3 years ago

alexxbb commented 3 years ago

Relm introduces some new types which are not explained at all in the docs. structs and traits like Component, Container, Widget etc could have at least a minimal explanation on what they are what they do and when and why to use them. For example the only place where I saw the use of Component is widgets_list.rs.

Any chance to get the docs updated with just the basics? Thanks!

antoyo commented 3 years ago

For now, there's the relm tutorial. That does not explain everything, but it's a start.

antoyo commented 3 years ago

Closing as it is a duplicate of #26.