]> de.git.xonotic.org Git - xonotic/netradiant.git/blobdiff - README.md
bikeshedding: spacing
[xonotic/netradiant.git] / README.md
index 762e8180216bcc966b738ba29cc26901f19eca5a..3b5fd112a7cf903925b9fcf3222f0eb61c27d4ba 100644 (file)
--- a/README.md
+++ b/README.md
@@ -50,6 +50,8 @@ cd netradiant
 
 To fetch default game packages you'll need Git, Subversion, Wget and `unzip`.
 
+It's possible to build against GTK3 using the `-DGTK_TARGET=3` cmake option, but some problems may be encountered, see [GUI/GTK](https://gitlab.com/xonotic/netradiant/-/issues?label_name[]=GUI%2FGTK3) issues. GTK2 remains recommended for now.
+
 
 ### Ubuntu:
 
@@ -77,8 +79,8 @@ export PATH="/mingw64/bin:${PATH}"
 Install the dependencies this way:
 
 ```sh
-pacman -S --needed base-devel git \
-    mingw-w64-$(uname -m)-{ntldd-git,subversion,unzip,toolchain,cmake,make,gtk2,gtkglext,libwebp,minizip-git}
+pacman -S --needed base-devel git subversion unzip \
+    mingw-w64-$(uname -m)-{ntldd-git,toolchain,cmake,make,gtk2,gtkglext,libwebp,minizip-git}
 ```
 
 Explicitely use `mingw-w64-x86_64-` or `mingw-w64-i686-` prefix instead of `mingw-w64-$(uname -m)` if you need to target a non-default architecture.
@@ -95,8 +97,10 @@ If you plan to build a bundle, you also need to install `patchelf`
 
 ### macOS:
 
+Note: some dependencies of gtk+ seems to only be pulled with gtk+3, gtkglext seems to require libffi.
+
 ```sh
-brew install cmake glib gtk+ pkgconfig minizip webp coreutils gnu-sed wget
+brew install cmake glib libffi gtk+ gtk+3 pkgconfig minizip webp coreutils gnu-sed wget sassc
 brew link --force gettext
 ```
 
@@ -220,7 +224,7 @@ Targets:
      * `quake3`         Compile all the Quake 3 tools:
          - `q3map2`     Compile the Quake 3 map compiler;
          - `q3data`     Compile the q3data tool;
-     * `unvanquished`   Compile all the Unvanquished tool: `daemonmap`, `q3map3`, `q4data`;
+     * `unvanquished`   Compile all the Unvanquished tools: `daemonmap`, `q3map3`, `q4data`;
          - `daemonmap`  Compile the daemonmap navigation mesh generator.
 
 Type `make help` to get an exhaustive list of targets.
@@ -231,9 +235,9 @@ Type `make help` to get an exhaustive list of targets.
 Options:
 
 * `DOWNLOAD_GAMEPACKS=OFF`  
-  Do not automatically download the gamepack data on each compilation and do not install game packs already downloaded (default: `ON`);
+  Do not automatically download the gamepack data on each compilation and do not install already downloaded game packs (default: `ON`);
 * `GAMEPACKS_LICENSE_LIST=all`  
-  Download all gamepacks whatever the license (default: `free`, download free gamepacks, can be set to `none` to only filter by name);
+  Download all gamepacks whatever their license (default: `free`, download free gamepacks, can be set to `none` to only filter by name);
 * `GAMEPACKS_NAME_LIST="Xonotic Unvanquished"`  
   Download gamepacks for the given games (default: `none`, do not select more gamepacks to download).