Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

git ref readme_deps #2355

Closed
wants to merge 2 commits into from
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,17 @@ you want to learn about a specific release, check out [the release list].

[the release list]: https://github.com/iced-rs/iced/releases

The majority of documentation currently follows the master branch,
it may be suggested to use git referenced dependency in your Cargo.toml file.
helloimalemur marked this conversation as resolved.
Show resolved Hide resolved

```toml
[dependencies.iced]
git = "https://github.com/iced-rs/iced.git"
branch = "master"
features = ["canvas", "tokio", "debug", "async-std", "lazy", "webgl"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

```


## Overview

Inspired by [The Elm Architecture], Iced expects you to split user interfaces
Expand Down