cbuf: improve some warns, minor cleanup

[xonotic/darkplaces.git] / README.md

diff --git a/README.md b/README.md
index b4ce03e1416250acc1adab6061a0c618c3bcd6b2..72e7b8d6fc1902c4d24044b9d60aa14ec46d1cdc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@ 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.
+Developed by LadyHavoc. See [CREDITS](CREDITS.md) for a list of contributors.
 
 ## Help/support
 
@@ -13,16 +13,21 @@ Developed by LadyHavoc. See 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
+
+These names are for Debian, you may need to find equivalents for your platform.
+
+##### 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,10 +57,17 @@ 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.
 
+## Contributing
+
+[DarkPlaces Contributing Guidelines](CONTRIBUTING.md)
+
 ## Documentation
 
 Doxygen: https://xonotic.org/doxygen/darkplaces