From 45e5612985b8f5c7f22486e9cadc41ac3221b593 Mon Sep 17 00:00:00 2001 From: Psypherium Date: Sun, 15 Apr 2018 10:42:17 +1000 Subject: [PATCH] Update README.md (#3181) * Update README.md - Add recompilation instructions - Add build threading instructions - Rearranged 1 sentence with passive voice to match the rest of the readme * Update README.md * Update README.md Clarification * Update README.md Rephrasing, reformatting --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7bafa5ece..43dcc594b 100644 --- a/README.md +++ b/README.md @@ -64,13 +64,13 @@ mesa-common-dev pkg-config zlib1g-dev ``` ### In-game recorder -In order to build the in-game recorder for STK, you have to install +To build the in-game recorder for STK, you have to install libopenglrecorder from your distribution, or compile it yourself from [here](https://github.com/Benau/libopenglrecorder). Compilation instruction is explained there. If you don't need this feature, pass `-DBUILD_RECORDER=off` to cmake. ### Compiling -Run the following commands inside `stk-code` directory to compile SuperTuxKart: +To compile SuperTuxKart, run the following commands inside `stk-code` directory: ```bash mkdir cmake_build @@ -80,6 +80,20 @@ make -j4 ``` STK can then be run from the build directory with `bin/supertuxkart` +#### Keeping your build up to date + +To recompile the latest code without redownloading the entire source, first run the ```svn up``` command inside the 'stk-assets' directory, then run the following commands inside the 'stk-code' directory: + +```git pull +cd cmake_build +cmake .. +make -j4 +``` + +##### Build Speed Optimization + +"-j4" is an example, for a faster build, use "-jx" instead, where "x" is the amount of CPU threads you have, minus one. + ### Further options To create a debug version of STK, run: