Merge branch 'crunch-submodule' into 'master'

[xonotic/netradiant.git] / README.md

diff --git a/README.md b/README.md
index 35a3194633262125fbac09d1589c3440725fb625..eb6bf9756e4256557e13621653db93363296293b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,7 +13,7 @@ http://git-scm.org
 
 To get a copy of the source using the commandline git client:
 ```
-git clone https://gitlab.com/xonotic/netradiant.git
+git clone --recursive https://gitlab.com/xonotic/netradiant.git
 cd netradiant
 ```
 
@@ -32,6 +32,8 @@ See also https://gitlab.com/xonotic/netradiant/ for a source browser, issues and
 
 ## msys2
 
+Under MSYS2, the mingw shell must be used
+
 ### 32 bit:
 
 ```
@@ -52,27 +54,31 @@ brew install Caskroom/cask/xquartz
 brew link --force gettext
 ```
 
+# Submodules
+
+ * Crunch
+
+If you forgot to add `--recursive` option at `git clone` time, fetch it this way:
+
+
+```
+git submodule update --init --recursive
+```
+
 # Compiling
 
 This project uses the usual CMake workflow:
 
 ## Debug
 
-`cmake -G "Unix Makefiles" -H. -Bbuild && cmake --build build -- -j$(nproc)`
+```
+cmake -G "Unix Makefiles" -H. -Bbuild && cmake --build build -- -j$(nproc)
+```
 
 ## Release
 
-`cmake -G "Unix Makefiles" -H. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build -- -j$(nproc)`
-
-## MSYS2
-
-Under MSYS2, the mingw shell must be used with the following additional flags:
-
 ```
-cmake -G "MSYS Makefiles" \
-    -DGTK2_GLIBCONFIG_INCLUDE_DIR=/mingw64/lib/glib-2.0/include \
-    -DGTK2_GDKCONFIG_INCLUDE_DIR=/mingw64/lib/gtk-2.0/include \
-    -H. -Bbuild
+cmake -G "Unix Makefiles" -H. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build -- -j$(nproc)
 ```
 
 ## More Compilation Details
@@ -91,3 +97,7 @@ targets:
  * `quake3`     Compiles all the Quake3 tools
    - `q3map2`     Quake3 map compiler
    - `q3data`
+
+## Note about Crunch
+
+The crnlib used to decode `.crn` files is the one from [Dæmon](http://github.com/DaemonEngine/Daemon) which is just the one by [Unity](https://github.com/Unity-Technologies/crunch/tree/unity) made cross-platform. Since Unity brokes compatibility with [BinomialLLC's legacy tree](https://github.com/BinomialLLC/crunch) it's required to use either crunch from Dæmon or the one from Unity to compress textures that have to be read by radiant or q3map2.