Add a proper README with build instructions and links to the available chats. To...
authorCloudwalk <cloudwalk009@gmail.com>
Sun, 30 May 2021 15:17:41 +0000 (11:17 -0400)
committerCloudwalk <cloudwalk009@gmail.com>
Sun, 30 May 2021 15:17:41 +0000 (11:17 -0400)
README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..f29527e
--- /dev/null
+++ b/README
@@ -0,0 +1,44 @@
+# DarkPlaces Engine
+
+DarkPlaces is a game engine based on the Quake 1 engine by id Software. It
+improves and builds upon the original 1996 engine by adding modern rendering
+features, and expanding upon the engine's native game code language QuakeC, as
+well as supporting additional map and model formats.
+
+Developed by LadyHavoc. See CREDITS.md for a list of contributors.
+
+## Help/support
+
+### IRC:
+#darkplaces on irc.anynet.org
+
+### Discord:
+https://discord.gg/ZHT9QeW
+
+## Build instructions (WIP)
+
+You will need the following packages regardless of platform:
+* SDL2
+* libjpeg
+* libpng
+* libvorbis
+* libogg
+
+### Windows (MSYS2):
+
+1. Install MSYS2, found [here](https://www.msys2.org/).
+2. Once you've installed MSYS2 and have fully updated it, open a MinGW64 terminal (***not an MSYS2 terminal***) and input the following command:
+
+```
+pacman -S --needed gcc make mingw-w64-x86_64-{toolchain,libjpeg-turbo,libpng,libogg,libvorbis,SDL2}
+```
+
+3. See [Unix instructions](#unix-(general)).
+
+### Unix (General)
+
+In the engine's root directory, run `make`. See `make help` for options.
+
+### Windows (Visual Studio)
+
+Instructions coming soon.
\ No newline at end of file