summaryrefslogtreecommitdiffstats
path: root/examples/tour/README.md
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2019-10-06 20:06:13 +0200
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2019-10-06 20:06:13 +0200
commit5286ef36b6a5eb6846b5675a7a4aced72601df3b (patch)
tree90f90a0e326c5c2eb598ba1a50c8096f0ea074ad /examples/tour/README.md
parent7765e6da50a3448501ee1b639e580c94a4fbda8a (diff)
downloadiced-5286ef36b6a5eb6846b5675a7a4aced72601df3b.tar.gz
iced-5286ef36b6a5eb6846b5675a7a4aced72601df3b.tar.bz2
iced-5286ef36b6a5eb6846b5675a7a4aced72601df3b.zip
Make `tour` a simple example instead of a crate
Diffstat (limited to 'examples/tour/README.md')
-rw-r--r--examples/tour/README.md66
1 files changed, 0 insertions, 66 deletions
diff --git a/examples/tour/README.md b/examples/tour/README.md
deleted file mode 100644
index 7ef1a212..00000000
--- a/examples/tour/README.md
+++ /dev/null
@@ -1,66 +0,0 @@
-# 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 can run both on native and web platforms, using the same GUI code!
-
-The native renderer of 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 web version uses `iced_web` directly. This crate is still a work in
-progress. In particular, the styling of elements is not finished yet
-(text color, alignment, sizing, etc).
-
-The implementation consists of different modules:
- - __[`tour`]__ contains the actual cross-platform GUI code: __state__,
- __messages__, __update logic__ and __view logic__.
- - __[`iced_ggez`]__ implements a simple renderer for each of the used widgets
- on top of the graphics module of [`ggez`].
- - __[`widget`]__ conditionally re-exposes the correct platform widgets based
- on the target architecture.
- - __[`main`]__ integrates Iced with [`ggez`] and connects the [`tour`] with
- the native [`renderer`].
- - __[`lib`]__ exposes the [`tour`] types and conditionally implements the
- WebAssembly entrypoint in the [`web`] module.
-
-The conditional compilation awkwardness from targetting both native and web
-platforms should be handled seamlessly by the `iced` crate in the near future!
-
-If you want to run it as a native app:
-
-```
-cd examples/tour
-cargo run
-```
-
-If you want to run it on web, you will need [`wasm-pack`]:
-
-```
-cd examples/tour
-wasm-pack build --target web
-```
-
-Then, simply serve the directory with any HTTP server. For instance:
-
-```
-python3 -m http.server
-```
-
-[![Tour - Iced][gui_gif]][gui_gfycat]
-
-[`ggez`]: https://github.com/ggez/ggez
-[`tour`]: src/tour.rs
-[`iced_ggez`]: src/iced_ggez
-[`renderer`]: src/iced_ggez/renderer
-[`widget`]: src/widget.rs
-[`main`]: src/main.rs
-[`lib`]: src/lib.rs
-[`web`]: src/web.rs
-[`wasm-pack`]: https://rustwasm.github.io/wasm-pack/installer/
-[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