X-Git-Url: http://git.xonotic.org/?p=xonotic%2Fnetradiant.git;a=blobdiff_plain;f=README.md;h=b4444130629debd256212c8e3a47cbeb121ec2e5;hp=3b5fd112a7cf903925b9fcf3222f0eb61c27d4ba;hb=refs%2Fheads%2Fmaster;hpb=e47e3afa806ffd805f91734dcd3cfcd68ad8d7b4 diff --git a/README.md b/README.md index 3b5fd112..280a61a6 100644 --- a/README.md +++ b/README.md @@ -100,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 ``` @@ -145,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 @@ -160,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 ``` @@ -168,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: @@ -177,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 ``` @@ -186,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 ``` @@ -205,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)"` @@ -224,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. @@ -264,8 +265,12 @@ Target: * `install` Install files. +```sh +cmake --install build +``` + -## Additonnal information +## Additional information ### About Crunch