]> de.git.xonotic.org Git - xonotic/darkplaces.git/commitdiff
README.md: various doc adjustments
authorbones_was_here <bones_was_here@xonotic.au>
Tue, 2 Apr 2024 07:57:03 +0000 (17:57 +1000)
committerbones_was_here <bones_was_here@xonotic.au>
Tue, 2 Apr 2024 07:57:03 +0000 (17:57 +1000)
GitHub happy splits `-rogue` over two lines...
OS X Carbon is long gone (along with GLX and WGL).

README.md
makefile

index 2a59e2f0ce2c3cd6ab8221bfd889d7e0bf2ae96b..168a911e76477903d27d4d76cefaad4dd7cffd65 100644 (file)
--- a/README.md
+++ b/README.md
@@ -22,7 +22,9 @@ Linux x86_64 builds are available in [GitHub CI](https://github.com/DarkPlacesEn
 More complete builds are available in [xonotic.org](https://beta.xonotic.org/autobuild/) engine zips.  
 These support Windows, Linux and macOS, and include the current libraries needed for all features.
 
 More complete builds are available in [xonotic.org](https://beta.xonotic.org/autobuild/) engine zips.  
 These support Windows, Linux and macOS, and include the current libraries needed for all features.
 
-DarkPlaces supports many Quake-based games and you can select which it will run by renaming the executable so it's prefixed with the game's name, for example `rogue-sdl.exe`, or by passing a cmdline argument such as `-rogue`.  This changes various engine behaviours and cvar defaults to suit the game.  The supported list and related details are defined in [com_game.c](https://github.com/DarkPlacesEngine/darkplaces/blob/master/com_game.c).
+DarkPlaces supports many Quake-based games and you can select which it will run by renaming the executable so it's prefixed with the game's name, for example `rogue-sdl.exe`, or by passing a cmdline argument  
+such as `-rogue`.  This changes various engine behaviours and cvar defaults to suit the game.  
+The supported list and related details are defined in [com_game.c](https://github.com/DarkPlacesEngine/darkplaces/blob/master/com_game.c).
 
 Mods which aren't listed there can be run with (for example) `-game quake15` in which case DP will use the same behaviours and cvar defaults as for id1 Quake.
 
 
 Mods which aren't listed there can be run with (for example) `-game quake15` in which case DP will use the same behaviours and cvar defaults as for id1 Quake.
 
@@ -32,8 +34,7 @@ All of Quake's data access is through a hierarchical file system, the contents
 of the file system can be transparently merged from several sources.
 
 The "base directory" is the path to the directory holding the quake.exe and
 of the file system can be transparently merged from several sources.
 
 The "base directory" is the path to the directory holding the quake.exe and
-all game directories.  The sys_* files pass this to host_init in
-quakeparms_t->basedir.  This can be overridden with the "-basedir" command
+all game directories.  This can be overridden with the "-basedir" command
 line parm to allow code debugging in a different directory.  The base
 directory is only used during filesystem initialization.
 
 line parm to allow code debugging in a different directory.  The base
 directory is only used during filesystem initialization.
 
@@ -84,16 +85,16 @@ brew install sdl2 libjpeg-turbo libpng libvorbis curl
 
 ### Unix (General)
 
 
 ### Unix (General)
 
-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.
+From a terminal, in the engine's root directory, input `make help` to list the targets.  
+To build the main executable, input `make sdl-release` which creates the file called  
+`darkplaces-sdl` or `darkplaces-sdl.exe` (Windows).
 
 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)
 
 
 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)
 
-May work but not recommended due to lack of support for C standards, and lack of maintenance.
+May work but not recommended due to lack of support for C standards, and lack of maintenance.  
 Instructions TODO.
 
 ## Contributing
 Instructions TODO.
 
 ## Contributing
index 6b01dcbfdf5de1088eafddcf4606cb958224b963..b62194cd42dc9a93e07649c33aec7b33817f054b 100644 (file)
--- a/makefile
+++ b/makefile
@@ -139,8 +139,6 @@ ifeq ($(DP_MAKE_TARGET), macosx)
        DP_LINK_CRYPTO_RIJNDAEL?=dlopen
        DP_LINK_XMP?=dlopen
 
        DP_LINK_CRYPTO_RIJNDAEL?=dlopen
        DP_LINK_XMP?=dlopen
 
-       # on OS X, we don't build the CL by default because it uses deprecated
-       # and not-implemented-in-64bit Carbon
        TARGETS_DEBUG=sv-debug sdl-debug
        TARGETS_PROFILE=sv-profile sdl-profile
        TARGETS_RELEASE=sv-release sdl-release
        TARGETS_DEBUG=sv-debug sdl-debug
        TARGETS_PROFILE=sv-profile sdl-profile
        TARGETS_RELEASE=sv-release sdl-release