From b56a517782354d8d8bae3b766754cb4635be931d Mon Sep 17 00:00:00 2001 From: faiface Date: Fri, 7 Sep 2018 18:00:48 +0200 Subject: [PATCH] make a README --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6086e67..e8e5057 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,24 @@ -# pixel-examples -Examples for the Pixel game library +## Pixel Examples + +This repository contains a few examples demonstrating [Pixel](https://github.com/faiface/pixel)'s functionality. + +**To run an example**, navigate to it's directory, then `go run` the `main.go` file. For example: + +``` +$ cd platformer +$ go run main.go +``` + +Here are some screenshots from the examples! + +| [Lights](lights) | [Platformer](platformer) | +| --- | --- | +| ![Lights](lights/screenshot.png) | ![Platformer](platformer/screenshot.png) | + +| [Smoke](smoke) | [Typewriter](typewriter) | +| --- | --- | +| ![Smoke](smoke/screenshot.png) | ![Typewriter](typewriter/screenshot.png) | + +| [Raycaster](community/raycaster) | [Starfield](community/starfield) | +| --- | --- | +| ![Raycaster](community/raycaster/screenshot.png) | ![Starfield](community/starfield/screenshot.png) |