Merge branch 'ellipsis' into 'master'

[xonotic/netradiant.git] / README.md

diff --git a/README.md b/README.md
index 90059acc4fc6408ee1306152ea3f5f8498ed0ea4..e38b9185de1fa352fa6ed802abcb18e3f2b7e1ff 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@ NetRadiant
 
 The open source, cross platform level editor for idtech games (Radiant fork).
 
-# Getting the Sources
+# Getting the sources
 
 The latest source is available from the git repository:
 https://gitlab.com/xonotic/netradiant.git
@@ -24,15 +24,15 @@ See also https://gitlab.com/xonotic/netradiant/ for a source browser, issues and
 
 # Dependencies
 
- * OpenGL
- * LibXml2
- * GTK2
- * GtkGLExt
- * LibJpeg
- * LibPng
- * LibWebp
- * Minizip
- * ZLib
+* OpenGL
+* LibXml2
+* GTK2
+* GtkGLExt
+* LibJpeg
+* LibPng
+* LibWebp
+* Minizip
+* ZLib
 
 ## msys2
 
@@ -63,7 +63,7 @@ brew link --force gettext
 
  * Crunch (optional, disabled by default, only supported with CMake build)
 
-If you have not used `--recursive` option at `git clone` time, you can fetch Crunch this way (run it whithin NetRadiant repository):
+If you have not used `--recursive` option at `git clone` time, you can fetch Crunch this way (run it within the NetRadiant repository):
 
 
 ```
@@ -86,26 +86,60 @@ cmake -G "Unix Makefiles" -H. -Bbuild && cmake --build build -- -j$(nproc)
 cmake -G "Unix Makefiles" -H. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build -- -j$(nproc)
 ```
 
-## More Compilation Details
+## Build and installation details
+
+### Compilation details
 
 options:
 
- * `DOWNLOAD_GAMEPACKS=ON`  
-   Automatically download the gamepack data during the first compilation
- * `BUILD_CRUNCH=ON`  
-   Enable crunch support
- * `RADIANT_ABOUTMSG="Custom build"`  
+* `BUILD_RADIANT=OFF`  
+   Do not build NetRadiant (default: `ON`, build radiant graphical editor)
+* `BUILD_TOOLS=OFF`  
+   Do not build q3map2 and other tools (default: `ON`, build command line tools)
+* `BUILD_CRUNCH=ON`  
+   Enable crunch support (default: `OFF`, disable crunch support)
+* `RADIANT_ABOUTMSG="Custom build"`  
    A message shown in the about dialog
 
 targets:
 
- * `radiant`    Compiles the radiant core binary
- * `modules`    Compiles all modules (each module has its own target as well)
- * `plugins`    Compiles all plugins (each plugin has its own target as well)
- * `game_packs` Downloads the game pack data
- * `quake3`     Compiles all the Quake3 tools
-   - `q3map2`     Quake3 map compiler
-   - `q3data`
+* `radiant`    Compiles the radiant core binary
+* `modules`    Compiles all modules (each module has its own target as well)
+* `plugins`    Compiles all plugins (each plugin has its own target as well)
+* `quake3`     Compiles all the Quake3 tools
+  - `q3map2`   Compiles the quake3 map compiler
+  - `q3data`   Compiles the q3data tool
+
+### Download details
+
+options:
+
+* `DOWNLOAD_GAMEPACKS=OFF`  
+   Do not automatically download the gamepack data during the first compilation (default: `ON`)
+* `GAMEPACKS_LICENSE_LIST=all`  
+   Download all gamepacks whatever the license (default: `free`, download free gamepacks)
+* `GAMEPACKS_NAME_LIST=Xonotic Unvanquished`  
+   Download gamepacks for the given games (default: `none`, do not select more gamepacks to download)
+
+target:
+
+* `game_packs` Downloads the game pack data
+
+Run `./gamepacks-manager -h` to know about available licenses and other available games. Both lists are merged, for example setting `GAMEPACKS_LICENSE_LIST=GPL` and `GAMEPACKS_NAME_LIST=Q3` will install both GPL gamepacks and proprietary Quake 3 one.
+
+### Installation details
+
+options:
+
+* `FHS_INSTALL=ON`  
+  Install files following the Filesystem Hierarchy Standard (bin, lib, share, etc.), also setup XDG mime and application support on POSIX systems (default: `OFF`, install like in 1999)
+* `CMAKE_INSTALL_PREFIX=/usr`  
+  Install system-wide on Posix systems, always set `FHS_INSTALL` to `ON` when doing this (default: install in `install/` directory within source tree)
+
+target:
+
+* `install`  
+  Install files
 
 ## Note about Crunch