netradiant: strip 16-bit png to 8-bit, fix #153

[xonotic/netradiant.git] / README.md

diff --git a/README.md b/README.md
index 3a84cbad53b13b905868044faa6bf096ee4ba725..dae993ca340c28ec1d66fc3197999d5867b6eaaa 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.
@@ -98,7 +100,7 @@ If you plan to build a bundle, you also need to install `patchelf`
 Note: some dependencies of gtk+ seems to only be pulled with gtk+3, gtkglext seems to require libffi.
 
 ```sh
-brew install cmake glib libffi gtk+ gtk+3 pkgconfig minizip webp coreutils gnu-sed wget sassc
+brew install cmake glib gobject-introspection libffi gtk+ gtk+3 gtk-doc pkgconfig minizip webp coreutils gnu-sed wget sassc
 brew link --force gettext
 ```
 
@@ -143,7 +145,7 @@ For supported system, bundling dependencies can be done this way:
 ./easy-builder -DBUNDLE_LIBRARIES=ON
 ```
 
-Note: always do bundling on a clean system without unrelated software installed.
+Note: Always do bundling on a clean and fresh system without unrelated software installed.
 
 
 ## Advanced compilation
@@ -158,6 +160,7 @@ This project uses the usual CMake workflow:
 ```sh
 cmake -G "Unix Makefiles" -S. -Bbuild -DCMAKE_BUILD_TYPE=Debug
 cmake --build build -- -j$(nproc)
+cmake --install build
 ```
 
 
@@ -166,6 +169,7 @@ cmake --build build -- -j$(nproc)
 ```sh
 cmake -G "Unix Makefiles" -S. -Bbuild -DCMAKE_BUILD_TYPE=Release
 cmake --build build -- -j$(nproc)
+cmake --install build
 ```
 
 Note: macOS users need to build built-in GtkGLExt before building NetRadiant:
@@ -175,6 +179,7 @@ cmake -G "Unix Makefiles" -S. -Bbuild -DCMAKE_BUILD_TYPE=Release
 cmake --build build -- -j$(nproc) builtins
 cmake -G "Unix Makefiles" -S. -Bbuild
 cmake --build build -- -j$(nproc)
+cmake --install build
 ```
 
 
@@ -184,12 +189,14 @@ The initial build will download the gamepacks and build NetRadiant and tools. If
 
 ```sh
 cmake --build build --target binaries -- -j$(nproc)
+cmake --install build
 ```
 
 You should still periodically update gamepacks:
 
 ```sh
 cmake --build build --target gamepacks
+cmake --install build
 ```
 
 
@@ -203,8 +210,6 @@ Options:
   Do not build NetRadiant (default: `ON`, build netradiant graphical editor);
 * `BUILD_TOOLS=OFF`  
   Do not build q3map2 and other tools (default: `ON`, build command line tools);
-* `BUILD_DAEMONMAP=OFF`  
-  Do not build daemonmap tool (default: `ON` if submodule is there, buils daemonmap navigation mesh generator);
 * `BUILD_CRUNCH=OFF`  
   Disable crunch support (default: `ON` if submodule is there, enable crunch support);
 * `RADIANT_ABOUTMSG="Custom build by $(whoami)"`  
@@ -222,8 +227,6 @@ 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 tools: `daemonmap`, `q3map3`, `q4data`;
-         - `daemonmap`  Compile the daemonmap navigation mesh generator.
 
 Type `make help` to get an exhaustive list of targets.
 
@@ -262,6 +265,10 @@ Target:
 
 * `install` Install files.
 
+```sh
+cmake --install build
+```
+
 
 ## Additonnal information