git ref readme_deps

[helloimalemur]

Hey Core Team!

Approaching Iced I found myself stumbling with getting dependencies to cooperate when using the version of Iced published to Crates.io while also referencing the current round of documentation on iced.rs.
I wasn't able to just "copy and paste" any of the examples and expect it work without coaxing.

I merely suggest a small change to the ReadMe file to include the git reference version of the Iced dependency, making users aware of their ability to reference the master branch directly in their Cargo.toml

Thanks for considering the suggestion!
James

[Koranir]

docs.rs documentation should be used for the crates.io releases. docs.iced.rs is for the latest master. On iced.rs, there are links to docs.rs for documentation on the latest release and to docs.iced.rs (which is explicitly referred to as the development branch).

I'm not quite sure how you ended up on the development branch's documentation, perhaps that is the problem we should be focusing on.

[helloimalemur]

The "Get Started" button on iced.rs takes you to book.iced.rs which coincides with the development branch (mentions the usage of new patterns like iced::run(), which seems to be new to 0.13, instead of implementing Application, and running the run method on it).
Perhaps the "Get Started" button on the main page should take the user to https://docs.iced.rs/iced/index.html until the book is complete and coincides with a release?

[Koranir]

The "Get Started" button on iced.rs takes you to book.iced.rs which coincides with the development branch (mentions the usage of new patterns like iced::run(), which seems to be new to 0.13, instead of implementing Application, and running the run method on it). Perhaps the "Get Started" button on the main page should take the user to https://docs.iced.rs/iced/index.html until the book is complete and coincides with a release?

Yeah, that should probably be the case. Looking at the book, it does have a header at the top that does say it is intended for the latest master branch, but that could easily be missed.

[Koranir]

Should these be the set of dependencies we recommend? Might be better to not include them at all.

[helloimalemur]

Thanks for the edit!
I do believe it would be helpful for anyone else who may be approaching the lib completely green to it, for them to be aware of this nuance, at least until 0.13 is released and all the docs align with a release. It could potentially help with adoption in the meantime.