diff --git a/README.md b/README.md new file mode 100644 index 0000000..f8644cf --- /dev/null +++ b/README.md @@ -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