]> git.xonotic.org Git - xonotic/darkplaces.git/blobdiff - README.md
SVVM: Fix segfault during shutdown, improve previous commit
[xonotic/darkplaces.git] / README.md
index f03bf95be25efd0e253205a1371e98051df4a069..c67c8be42bb2794670776e0f3220278ffd9ad371 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,16 +13,22 @@ Developed by LadyHavoc. See [CREDITS](CREDITS.md) for a list of contributors.
 #darkplaces on irc.anynet.org
 
 ### [Matrix](https://matrix.org/docs/guides/introduction)
-Space: [#darkplaces:matrix.org](https://matrix.to/#/#darkplaces:matrix.org)
+[![#darkplaces:matrix.org](https://img.shields.io/matrix/darkplaces:matrix.org?color=660000&label=%23darkplaces%3Amatrix.org)](https://matrix.to/#/#darkplaces:matrix.org)
 
 ## Build instructions (WIP)
 
-You will need the following packages regardless of platform:
-* SDL2
-* libjpeg
-* libpng
-* libvorbis
-* libogg
+### Required packages
+
+The minimum SDL version is 2.0.18 for Linux and 2.24.0 for Windows.  
+The following package names are for Debian, see below for Windows and Mac.
+
+##### Client
+Build (mandatory): `build-essential` `libjpeg-dev` `libsdl2-dev`  
+Runtime (optional): `libcurl` `libpng` `libfreetype6` `libvorbisfile`  
+
+##### Dedicated Server
+Build (mandatory): `build-essential` `libjpeg-dev` `zlib1g-dev`  
+Runtime (optional): `libcurl` `libpng`  
 
 ### Windows (MSYS2):
 
@@ -52,9 +58,12 @@ From a terminal, in the engine's root directory, input `make`. On macOS, input `
 
 Input `make help` for options.
 
+If you get errors (that don't seem to be about missing dependencies) try `make clean` before compiling, especially if you updated your system since the last time you compiled.
+
+
 ### Windows (Visual Studio)
 
-Instructions coming soon.
+Instructions TODO.
 
 ## Contributing