diff options
| author |  Héctor Ramón Jiménez <hector0193@gmail.com> | 2019-09-05 09:37:54 +0200 |
|---|---|---|
| committer | Héctor Ramón Jiménez <hector0193@gmail.com> | 2019-09-05 09:37:54 +0200 |
| commit | b81ab91e671c4dc65567e6c68a205eecd7f87f32 (patch) | |
| tree | 119973d3f6675b373082070b2e113e3ab35d4ebb /examples/tour/README.md | |
| parent | ced3ffc22570048711fefba638782a31d0e06035 (diff) | |
| download | iced-b81ab91e671c4dc65567e6c68a205eecd7f87f32.tar.gz iced-b81ab91e671c4dc65567e6c68a205eecd7f87f32.tar.bz2 iced-b81ab91e671c4dc65567e6c68a205eecd7f87f32.zip | |
Complete examples `README`
Diffstat (limited to 'examples/tour/README.md')
| -rw-r--r-- | examples/tour/README.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/examples/tour/README.md b/examples/tour/README.md new file mode 100644 index 00000000..0e9d6eda --- /dev/null +++ b/examples/tour/README.md @@ -0,0 +1,35 @@ +# Tour + +A simple UI tour showcasing different widgets that can be built using Iced. It +also shows how the library can be integrated into an existing system. + +The example is built on top of [`ggez`], a game library for Rust. Currently, it +is using a [personal fork] to [add a `FontCache` type] and +[fix some issues with HiDPI]. + +The implementation consists of different modules: + - __[`tour`]__ contains the actual GUI code: __state__, __messages__, + __update logic__ and __view logic__. + - __[`renderer`]__ implements a simple renderer for each of the used widgets on + top of the graphics module of [`ggez`]. + - __[`widget`]__ re-exposes Iced's built-in widgets with the renderer type parameter + replaced with the implemented [`renderer`], for convenience. + - __[`main`]__ integrates Iced with [`ggez`] and connects the [`tour`] with + the [`renderer`]. + +``` +cargo run --example tour +``` + +[![Tour - Iced][gui_gif]][gui_gfycat] + +[`ggez`]: https://github.com/ggez/ggez +[`tour`]: tour/tour.rs +[`renderer`]: tour/renderer +[`widget`]: tour/widget.rs +[`main`]: tour/main.rs +[personal fork]: https://github.com/hecrj/ggez +[add a `FontCache` type]: https://github.com/ggez/ggez/pull/679 +[fix some issues with HiDPI]: https://github.com/hecrj/ggez/commit/dfe2fd2423c51a6daf42c75f66dfaeaacd439fb1 +[gui_gif]: https://thumbs.gfycat.com/VeneratedSourAurochs-small.gif +[gui_gfycat]: https://gfycat.com/veneratedsouraurochs |