summaryrefslogtreecommitdiffstats
path: root/examples/pure/tour/README.md
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2022-02-13 22:19:43 +0700
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2022-02-13 22:19:43 +0700
commitcff891833be68c0e2d4919d4475daf23da821f9b (patch)
treed9eb6944583ae06bec2f6bf8fef3f9eb2981ac8e /examples/pure/tour/README.md
parent6689ede6d8ce0d65ec3ce29fd863ec7f26052621 (diff)
downloadiced-cff891833be68c0e2d4919d4475daf23da821f9b.tar.gz
iced-cff891833be68c0e2d4919d4475daf23da821f9b.tar.bz2
iced-cff891833be68c0e2d4919d4475daf23da821f9b.zip
Implement `pure` version of the `tour` example :tada:
Diffstat (limited to '')
-rw-r--r--examples/pure/tour/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/examples/pure/tour/README.md b/examples/pure/tour/README.md
new file mode 100644
index 00000000..e7cd2d5c
--- /dev/null
+++ b/examples/pure/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`]: https://github.com/iced-rs/iced_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`]: https://github.com/iced-rs/iced_web#usage