readme

2024-08-29 18:10:16 -04:00 · 2024-08-29 18:10:16 -04:00 · 3599baea22
commit 3599baea22
parent 0a3cc7284c
1 changed files with 29 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,29 @@
+# Frillrun
+
+My entry for the 2024 WeightGaming Gain Jam. Action game where you collect stuff while random events occur.
+
+## Build
+
+### Dependencies
+
+	- SDL2
+	- SDL_image
+	- SDL_mixer
+	- SDL_ttf
+    - GLEW
+
+### Linux
+
+This repository uses CMake to compile, so:
+
+`mkdir build`
+
+`cd build`
+
+`cmake ..`
+
+`make`
+
+### Windows
+
+I used MinGW for the Windows build, so basically the same as Linux but you'll need to use MSYS, MinGW, etc. to compile it.