]> de.git.xonotic.org Git - xonotic/darkplaces.git/blobdiff - README.md
Release the mouse during loading screen
[xonotic/darkplaces.git] / README.md
index 6b5ecb978d7091b1dd6348c328f9b3c7fc42caac..f03bf95be25efd0e253205a1371e98051df4a069 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,15 +5,15 @@ 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
 
-### IRC:
+### IRC
 #darkplaces on irc.anynet.org
 
-### Discord:
-https://discord.gg/ZHT9QeW
+### [Matrix](https://matrix.org/docs/guides/introduction)
+Space: [#darkplaces:matrix.org](https://matrix.to/#/#darkplaces:matrix.org)
 
 ## Build instructions (WIP)
 
@@ -35,15 +35,31 @@ pacman -S --needed gcc make mingw-w64-x86_64-{toolchain,libjpeg-turbo,libpng,lib
 
 3. See [Unix instructions](#unix-(general)).
 
+### macOS
+1. Open a terminal and input `xcode-select --install`
+2. Install [Homebrew](https://brew.sh)
+3. In the same (or a different terminal), input the following command:
+
+```
+brew install sdl2 libjpeg-turbo libpng libvorbis curl
+```
+
+4. See [Unix instructions](#unix-(general)).
+
 ### Unix (General)
 
-In the engine's root directory, run `make`. See `make help` for options.
+From a terminal, in the engine's root directory, input `make`. On macOS, input `make` with a target such as `make sdl-release`.
+
+Input `make help` for options.
 
 ### Windows (Visual Studio)
 
 Instructions coming soon.
 
+## Contributing
+
+[DarkPlaces Contributing Guidelines](CONTRIBUTING.md)
+
 ## Documentation
 
 Doxygen: https://xonotic.org/doxygen/darkplaces
-