diff options
| author |  Héctor Ramón Jiménez <hector0193@gmail.com> | 2020-01-20 06:40:20 +0100 |
|---|---|---|
| committer | Héctor Ramón Jiménez <hector0193@gmail.com> | 2020-01-20 06:40:20 +0100 |
| commit | e2ec092aeca64a8107070d72c42c5805dc2c245b (patch) | |
| tree | 1833dacef73d35645ef074ff7c9f6d0ad2620e47 /examples/tour | |
| parent | 7cea7371150e6de28032827519936008592f112d (diff) | |
| download | iced-e2ec092aeca64a8107070d72c42c5805dc2c245b.tar.gz iced-e2ec092aeca64a8107070d72c42c5805dc2c245b.tar.bz2 iced-e2ec092aeca64a8107070d72c42c5805dc2c245b.zip | |
Add `README` for `tour` example
Diffstat (limited to 'examples/tour')
| -rw-r--r-- | examples/tour/Cargo.toml | 2 | ||||
| -rw-r--r-- | examples/tour/README.md | 28 |
2 files changed, 29 insertions, 1 deletions
diff --git a/examples/tour/Cargo.toml b/examples/tour/Cargo.toml index 10c3f1da..7772df1b 100644 --- a/examples/tour/Cargo.toml +++ b/examples/tour/Cargo.toml @@ -6,7 +6,7 @@ edition = "2018" publish = false [dependencies] -iced = { path = "../.." } +iced = { path = "../..", features = ["debug"] } env_logger = "0.7" [target.'cfg(target_arch = "wasm32")'.dependencies] diff --git a/examples/tour/README.md b/examples/tour/README.md new file mode 100644 index 00000000..f380931a --- /dev/null +++ b/examples/tour/README.md @@ -0,0 +1,28 @@ +## Tour + +A simple UI tour that can run both on native platforms and the web! It showcases different widgets that can be built using Iced. + +The __[`main`]__ file contains all the code of the example! All the cross-platform GUI is defined in terms of __state__, __messages__, __update logic__ and __view logic__. + +<div align="center"> + <a href="https://gfycat.com/politeadorableiberianmole"> + <img src="https://thumbs.gfycat.com/PoliteAdorableIberianmole-small.gif"> + </a> +</div> + +[`main`]: src/main.rs +[`iced_winit`]: ../../winit +[`iced_native`]: ../../native +[`iced_wgpu`]: ../../wgpu +[`iced_web`]: ../../web +[`winit`]: https://github.com/rust-windowing/winit +[`wgpu`]: https://github.com/gfx-rs/wgpu-rs + +You can run the native version with `cargo run`: +``` +cargo run --package tour +``` + +The web version can be run by following [the usage instructions of `iced_web`] or by accessing [iced.rs](https://iced.rs/)! + +[the usage instructions of `iced_web`]: ../../web#usage |