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

Suggested new page: How to use the examples. #9

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
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
Suggested new page.
  • Loading branch information
ryankopf committed Jun 3, 2024
commit 0caf98f8c1e11ec1f2210b5989f656d4b9a0f28a
1 change: 1 addition & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -28,3 +28,4 @@

# Appendix
- [Additional Resources](additional-resources.md)
- [How To Use Examples](examples.md)
16 changes: 16 additions & 0 deletions src/examples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Using The Examples

Iced is a fast-moving GUI with an architecture that is changing and being updated frequently.

When looking at the examples, it is important to ensure you are using the same iced version as the examples. The examples on GitHub follow the latest changes to Iced.

To follow along with the examples, you can add the following to your `Cargo.toml`:

```toml
iced = { git = "https://github.com/iced-rs/iced", branch = "master", features = ["tokio"] }
```


For a good starting point, check out the [Counter Example](https://github.com/iced-rs/iced/tree/master/examples/counter), which is the example contained in this book. Remember to use the "master" branch if you are looking at an example in the "master" branch.

You can also explore the branches for [previous versions](https://github.com/iced-rs/iced/branches) on Github for older versions and examples.