aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJordan Halase <jordan@halase.me>2019-09-30 10:39:29 -0500
committerJordan Halase <jordan@halase.me>2019-09-30 10:39:29 -0500
commit5b257ef6d3a528a20370d1c553fcedfd32db7ef9 (patch)
treea778ffef6864855eb31b509e9d65e16a0180b0b9
parenta9798702ddb7e4bcb7b9154db08579ed07faadfb (diff)
Use markdown README.md
-rw-r--r--README.md22
-rw-r--r--readme.txt5
2 files changed, 22 insertions, 5 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2076702
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+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.
+
+### Linux
+
+#### APT (Debian, Ubuntu, Raspbian)
+
+`sudo apt update`
+`sudo apt install libsdl2-dev`
+
+#### Yum (Red Hat, Fedora, CentOS)
+
+`sudo yum install SDL2-devel`
+
+#### Pacman (Arch)
+
+`sudo pacman -S sdl2`
diff --git a/readme.txt b/readme.txt
deleted file mode 100644
index 4efc9e5..0000000
--- a/readme.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-Simple Asteroids clone in C as an exercise in game development.
-
-Requires SDL2 for input and drawing. Details for installation at libsdl.org.
-
-Compiles with gcc or clang. Can compile on Windows with clang or mingw.