aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorJordan Halase <jordan@halase.me>2019-09-30 12:30:24 -0500
committerJordan Halase <jordan@halase.me>2019-09-30 12:30:24 -0500
commitc28b5a398520b71ea95f3160de29f59183dd3433 (patch)
treeefe7320d4308b04d93cebe56b0944761a76e8a3f /readme.md
parentdd0bc299e39e1afb8acfd34698d6bea8f9df8587 (diff)
Build with CMake
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md15
1 files changed, 7 insertions, 8 deletions
diff --git a/readme.md b/readme.md
index 87b2125..114a846 100644
--- a/readme.md
+++ b/readme.md
@@ -4,14 +4,13 @@ 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.
+* Compiles with gcc or clang. Can compile on Windows with clang or mingw. MSVC is not supported.
-In order to compile, the SDL2 development libraries are needed.
+## Building
-* Debian, Ubuntu, Raspbian: `sudo apt install libsdl2-dev`
+This project is built with [CMake](https://cmake.org). On Windows, CMake must be manually configured to locate the include and library paths for SDL2.
-* Red Hat, Fedora, CentOS: `sudo yum install SDL2-devel`
-
-* Arch: `sudo pacman -S sdl2`
-
-* macOS (with [Homebrew](https://brew.sh)): `brew install sdl2`
+Simplest way to build on most \*nix systems:
+ 1. `mkdir build && cd build`
+ 2. `cmake ..`
+ 3. `make`