Complete examples README

This commit is contained in:
Héctor Ramón Jiménez 2019-09-05 09:37:54 +02:00
parent ced3ffc225
commit b81ab91e67
4 changed files with 61 additions and 12 deletions

View file

@ -15,6 +15,16 @@ 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
```
@ -22,6 +32,10 @@ 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
@ -35,7 +49,7 @@ 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.
the __[`ui` module]__ in [Coffee] is probably your best choice as of now.
[![Tour - Coffee][coffee_gui_gif]][coffee_gui_gfycat]