aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorJordan Halase <jordan@halase.me>2019-09-30 10:58:03 -0500
committerJordan Halase <jordan@halase.me>2019-09-30 10:58:03 -0500
commitbeeb3c3b0379a9d7f12f99393d67546cb973968a (patch)
treed2c840fcb39dc36a0d3699b245b247f9760be09c /readme.md
parent5b257ef6d3a528a20370d1c553fcedfd32db7ef9 (diff)
Update readme
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..29b3e4b
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,17 @@
+# Simple Asteroids Clone
+
+Simple Asteroids clone in C as an exercise in game development.
+
+* Requires [SDL2](https://libsdl.org) for input and drawing.
+
+* Compiles with gcc or clang. Can compile on Windows with clang or mingw. Visual Studio is not supported.
+
+In order to compile, the SDL2 development libraries are needed.
+
+* Debian, Ubuntu, Raspbian: `sudo apt install libsdl2-dev`.
+
+* Red Hat, Fedora, CentOS: `sudo yum install SDL2-devel
+
+* Arch: `sudo pacman -S sdl2`
+
+* macOS (with [Homebrew](https://brew.sh)): `brew install sdl2`