summaryrefslogtreecommitdiffstats
path: root/examples/README.md
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2019-11-20 10:54:40 +0100
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2019-11-20 10:54:40 +0100
commit08aa862a42b8bd710b3add7408b090d1fc918cab (patch)
treefbbf8429d3ce46f277db0ed4dbe570c67be2fe4d /examples/README.md
parent409b2db994980879355dc8ce0d065500a545ca61 (diff)
downloadiced-08aa862a42b8bd710b3add7408b090d1fc918cab.tar.gz
iced-08aa862a42b8bd710b3add7408b090d1fc918cab.tar.bz2
iced-08aa862a42b8bd710b3add7408b090d1fc918cab.zip
Update examples `README`
Diffstat (limited to 'examples/README.md')
-rw-r--r--examples/README.md73
1 files changed, 34 insertions, 39 deletions
diff --git a/examples/README.md b/examples/README.md
index 0a06a012..95ec6c5c 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -4,29 +4,17 @@ you want to learn about a specific release, check out [the release list].
[the release list]: https://github.com/hecrj/iced/releases
-
## [Tour](tour.rs)
-A simple UI tour showcasing different widgets that can be built using Iced.
-
-The example can run both on native and web platforms, using the same GUI code!
-
-[![Tour - Iced][gui_gif]][gui_gfycat]
-
-[gui_gif]: https://thumbs.gfycat.com/VeneratedSourAurochs-small.gif
-[gui_gfycat]: https://gfycat.com/veneratedsouraurochs
-On native, the example uses:
- - [`iced_winit`], as a bridge between [`iced_native`] and [`winit`].
- - [`iced_wgpu`], a WIP Iced renderer built on top of [`wgpu`] and supporting
- Vulkan, Metal, D3D11, and D3D12 (OpenGL and WebGL soon!).
+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 web version uses [`iced_web`], which is still a work in progress. In
-particular, the styling of elements is not finished yet (text color, alignment,
-sizing, etc).
+The __[`tour`]__ 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__.
-The __[`tour`]__ 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>
[`tour`]: tour.rs
[`iced_winit`]: ../winit
@@ -36,42 +24,49 @@ __update logic__ and __view logic__.
[`winit`]: https://github.com/rust-windowing/winit
[`wgpu`]: https://github.com/gfx-rs/wgpu-rs
-#### Running the native version
-Use [Cargo](https://doc.rust-lang.org/cargo/reference/manifest.html#examples)
-to run the example:
-
+You can run the native version with `cargo run`:
```
cargo run --example tour
```
-#### Running the web version
-Build using the `wasm32-unknown-unknown` target and use the [`wasm-bindgen`] CLI
-to generate appropriate bindings in a `tour` directory.
+The web version can be run by following [the usage instructions of `iced_web`] or by accessing [iced.rs](https://iced.rs/)!
-```
-cd examples
-cargo build --example tour --target wasm32-unknown-unknown
-wasm-bindgen ../target/wasm32-unknown-unknown/debug/examples/tour.wasm --out-dir tour --web
-```
+[the usage instructions of `iced_web`]: ../web#usage
-Finally, serve the `examples` directory using an HTTP server and access the
-`tour.html` file.
-[`wasm-bindgen`]: https://github.com/rustwasm/wasm-bindgen
+## [Todos](todos.rs)
+
+A simple todos tracker inspired by [TodoMVC]. It showcases dynamic layout, text input, checkboxes, scrollables, icons, and async actions! It automatically saves your tasks in the background, even if you did not finish typing them.
+
+All the example code is located in the __[`todos`]__ file.
+
+<div align="center">
+ <a href="https://gfycat.com/littlesanehalicore">
+ <img src="https://thumbs.gfycat.com/LittleSaneHalicore-small.gif" height="400px">
+ </a>
+</div>
+
+You can run the native version with `cargo run`:
+```
+cargo run --example todos
+```
+We have not yet implemented a `LocalStorage` version of the auto-save feature. Therefore, it does not work on web _yet_!
+[`todos`]: todos.rs
+[TodoMVC]: http://todomvc.com/
## [Coffee]
Since [Iced was born in May], it has been powering the user interfaces in
[Coffee], an experimental 2D game engine.
-If you want to give Iced a try without having to write your own renderer,
-the __[`ui` module]__ in [Coffee] is probably your best choice as of now.
-[![Tour - Coffee][coffee_gui_gif]][coffee_gui_gfycat]
+<div align="center">
+ <a href="https://gfycat.com/gloomyweakhammerheadshark">
+ <img src="https://thumbs.gfycat.com/GloomyWeakHammerheadshark-small.gif">
+ </a>
+</div>
[Iced was born in May]: https://github.com/hecrj/coffee/pull/35
[`ui` module]: https://docs.rs/coffee/0.3.2/coffee/ui/index.html
[Coffee]: https://github.com/hecrj/coffee
-[coffee_gui_gif]: https://thumbs.gfycat.com/GloomyWeakHammerheadshark-small.gif
-[coffee_gui_gfycat]: https://gfycat.com/gloomyweakhammerheadshark