make a README
This commit is contained in:
parent
bc29868459
commit
b56a517782
26
README.md
26
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) |
|
||||
|
|
Loading…
Reference in New Issue