Add README.md
This commit is contained in:
parent
3f65829e43
commit
1e1ee15c13
1 changed files with 29 additions and 0 deletions
29
README.md
Normal file
29
README.md
Normal file
|
|
@ -0,0 +1,29 @@
|
||||||
|
# go-raytracer
|
||||||
|
|
||||||
|
A simple raycasting demo written in Go using SDL2.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
- Go 1.24+
|
||||||
|
- SDL2 development libraries installed on your system
|
||||||
|
|
||||||
|
## Run
|
||||||
|
|
||||||
|
```bash
|
||||||
|
go run .
|
||||||
|
```
|
||||||
|
|
||||||
|
Or build the binary with:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make game
|
||||||
|
./game
|
||||||
|
```
|
||||||
|
|
||||||
|
## Controls
|
||||||
|
|
||||||
|
- Arrow Up / Down: move forward and backward
|
||||||
|
- Arrow Left / Right: rotate
|
||||||
|
- `m`: toggle minimap
|
||||||
|
- `p`: toggle palette debug view
|
||||||
|
- `Esc`: quit
|
||||||
Loading…
Add table
Add a link
Reference in a new issue