summaryrefslogtreecommitdiffstats
path: root/examples
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2020-05-04 23:54:28 +0200
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2020-05-04 23:54:28 +0200
commit93c6be5eef577f0778b5787dac37351c035ed471 (patch)
treedd727f138641fbda008af8e7827369cc99420749 /examples
parent80e2d1b08bd8e6d9a049367d49c1508ce8ffe2a3 (diff)
downloadiced-93c6be5eef577f0778b5787dac37351c035ed471.tar.gz
iced-93c6be5eef577f0778b5787dac37351c035ed471.tar.bz2
iced-93c6be5eef577f0778b5787dac37351c035ed471.zip
Update `README` of `game_of_life` example
Diffstat (limited to 'examples')
-rw-r--r--examples/README.md21
-rw-r--r--examples/game_of_life/README.md7
2 files changed, 26 insertions, 2 deletions
diff --git a/examples/README.md b/examples/README.md
index 7e7bda9d..8e1b781f 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -50,6 +50,27 @@ We have not yet implemented a `LocalStorage` version of the auto-save feature. T
[TodoMVC]: http://todomvc.com/
+## [Game of Life](game_of_life)
+An interactive version of the [Game of Life], invented by [John Horton Conway].
+
+It runs a simulation in a background thread while allowing interaction with a `Canvas` that displays an infinite grid with zooming, panning, and drawing support.
+
+The relevant code is located in the __[`main`](game_of_life/src/main.rs)__ file.
+
+<div align="center">
+ <a href="https://gfycat.com/briefaccurateaardvark">
+ <img src="https://thumbs.gfycat.com/BriefAccurateAardvark-size_restricted.gif">
+ </a>
+</div>
+
+You can run it with `cargo run`:
+```
+cargo run --package game_of_life
+```
+
+[Game of Life]: https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life
+[John Horton Conway]: https://en.wikipedia.org/wiki/John_Horton_Conway
+
## [Styling](styling)
An example showcasing custom styling with a light and dark theme.
diff --git a/examples/game_of_life/README.md b/examples/game_of_life/README.md
index 5741cbf6..1aeb1455 100644
--- a/examples/game_of_life/README.md
+++ b/examples/game_of_life/README.md
@@ -1,7 +1,8 @@
## Game of Life
-An interactive version of the Game of Life, invented by John Conway, implemented
-on top of a `Canvas` widget and other controls.
+An interactive version of the [Game of Life], invented by [John Horton Conway].
+
+It runs a simulation in a background thread while allowing interaction with a `Canvas` that displays an infinite grid with zooming, panning, and drawing support.
The __[`main`]__ file contains the relevant code of the example.
@@ -17,3 +18,5 @@ cargo run --package game_of_life
```
[`main`]: src/main.rs
+[Game of Life]: https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life
+[John Horton Conway]: https://en.wikipedia.org/wiki/John_Horton_Conway