From d56625577d995ef4c899ce3638bb2de2ba3e29e0 Mon Sep 17 00:00:00 2001 From: Jay Oster Date: Wed, 6 Nov 2019 22:37:16 -0800 Subject: [PATCH] Update READMEs (#42) --- README.md | 9 ++------- examples/conway/README.md | 5 +++++ examples/invaders/README.md | 6 ++++++ 3 files changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1d977f3..d63a6b9 100644 --- a/README.md +++ b/README.md @@ -19,13 +19,8 @@ Rapidly prototype a simple 2D game, pixel-based animations, software renderers, ## Examples -To demonstrate `pixels`, I've written a Space Invaders clone. The game logic can be found in the `simple-invaders` crate. The included example uses `simple-invaders` to rasterize the image, and `pixels` to display it. `winit` provides the windowing and event handling. - -```bash -cargo run --release --example invaders -``` - -See the [example's README](./examples/invaders) for more information. +- [Pixel Invaders](./examples/invaders) +- [Conway's Game of Life](./examples/conway) ## Comparison with `minifb` diff --git a/examples/conway/README.md b/examples/conway/README.md index d75cf05..a931f11 100644 --- a/examples/conway/README.md +++ b/examples/conway/README.md @@ -2,6 +2,11 @@ ![Conway's Game of Life](../../img/conway.png) +## Running + +```bash +cargo run --release --example conway +``` ## Controls diff --git a/examples/invaders/README.md b/examples/invaders/README.md index 6804730..cfc0fe7 100644 --- a/examples/invaders/README.md +++ b/examples/invaders/README.md @@ -4,6 +4,12 @@ The pixels have invaded! +## Running + +```bash +cargo run --release --example invaders +``` + ## Controls Left Right Move tank