From 84b8fe0b27a0611b5f1b16f3d5f00259b6045ecd Mon Sep 17 00:00:00 2001 From: Roger Date: Mon, 2 Sep 2019 12:33:46 -0400 Subject: [PATCH] Fix format of INSTALL.md (#4054) --- INSTALL.md | 101 ++++++++++++++++++++++++++++++----------------------- 1 file changed, 58 insertions(+), 43 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 67469bcef..130ae9374 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,4 +1,4 @@ -## Building from source +# Building from source In order to build SuperTuxKart from source, you'll need both the code and the assets (See for more information): @@ -13,19 +13,19 @@ svn co https://svn.code.sf.net/p/supertuxkart/code/stk-assets stk-assets To build SuperTuxKart from source, you'll need to install the following packages: - * OpenGL (mesa) - * OpenAL (recommended: openal-soft-devel) - * Ogg (libogg-dev) - * Vorbis (libvorbis-dev) - * Freetype (libfreetype6-dev) - * Harfbuzz (libharfbuzz-dev) - * Fribidi (libfribidi-dev) - * libcurl (libcurl-devel) - * libbluetooth (bluez-devel) - * libnettle (nettle-dev) - * libpng (libpng-devel) - * zlib (zlib-devel) - * jpeg (libjpeg-turbo-devel) +* OpenGL (mesa) +* OpenAL (recommended: openal-soft-devel) +* Ogg (libogg-dev) +* Vorbis (libvorbis-dev) +* Freetype (libfreetype6-dev) +* Harfbuzz (libharfbuzz-dev) +* Fribidi (libfribidi-dev) +* libcurl (libcurl-devel) +* libbluetooth (bluez-devel) +* libnettle (nettle-dev) +* libpng (libpng-devel) +* zlib (zlib-devel) +* jpeg (libjpeg-turbo-devel) Fedora command: @@ -35,6 +35,7 @@ openssl-devel libcurl-devel freetype-devel harfbuzz-devel fribidi-devel mesa-lib libjpeg-turbo-devel libogg-devel openal-soft-devel libpng-devel \ libvorbis-devel libXrandr-devel libGLEW nettle-devel pkgconf zlib-devel ``` + Mageia 6 command: ```bash @@ -43,6 +44,7 @@ fribidi-devel libjpeg-turbo-devel libogg-devel openal-soft-devel \ libpng-devel libvorbis-devel nettle-devel zlib-devel git subversion \ mesa-comon-devel libxrandr-devel libbluez-devel libfreetype6-devel' ``` + OpenSUSE command: ```bash @@ -51,6 +53,7 @@ freetype-devel harfbuzz-devel fribidi-devel libogg-devel openal-soft-devel libpn libvorbis-devel libXrandr-devel pkgconf zlib-devel enet-devel glew-devel \ libjpeg-devel bluez-devel freetype2-devel glu-devel ``` + Ubuntu command: ```bash @@ -69,18 +72,18 @@ Compilation instruction is explained there. If you don't need this feature, pass ### Compiling To compile SuperTuxKart, run the following commands inside `stk-code` directory - + ```bash # go into the stk-code directory cd stk-code - + # create and enter the cmake_build directory mkdir cmake_build cd cmake_build - + # run cmake to generate the makefile cmake .. - + # compile make -j$(nproc) ``` @@ -122,32 +125,33 @@ will be copied to `/usr/local/bin`. To change the default installation location, specify `CMAKE_INSTALL_PREFIX` when running cmake, e.g.: `cmake .. -DCMAKE_INSTALL_PREFIX=/opt/stk` - - ## Building SuperTuxKart on Windows + To Build SuperTuxKart on Windows, follow these instructions: 1. Download and install Visual Studio from here: [Visual Studio - Download](https://www.visualstudio.com/downloads/). The free Visual Studio Community edition works fine. Remember to select "Desktop development with C++" in the installer. -2a. If you want the stable version, download the SuperTuxKart source package from the latest stable version [SuperTuxKart download area - SourceForge.net](https://sourceforge.net/projects/supertuxkart/files/SuperTuxKart/) and unpack it. -2b. If you want the development version, you will need a Git client and a SVN client. More information can be found here: [SuperTuxKart.net - Source Control](https://supertuxkart.net/Source_control). +2. If you want the stable version, download the SuperTuxKart source package from the latest stable version [SuperTuxKart download area - SourceForge.net](https://sourceforge.net/projects/supertuxkart/files/SuperTuxKart/) and unpack it. + +3. If you want the development version, you will need a Git client and a SVN client. More information can be found here: [SuperTuxKart.net - Source Control](https://supertuxkart.net/Source_control). Open your file browser and find somewhere you want to put the development version of SuperTuxKart. For example in C:\Users\ as the Git and SVN clients will have write permissions there, and you should create its own directory, for example SuperTuxKart-dev. Enter that directory, and create a directory inside called stk-assets, and enter it. If you installed TortoiseSVN, right-click, select TortoiseSVN -> Checkout... and paste the correspodning URL found in [SuperTuxKart.net - Source Control](https://supertuxkart.net/Source_control). While it is downloading the game assets, go back to your file browser and one level up. Right-click again somewhere empty and select "Git clone..." and paste the corresponding link found in [SuperTuxKart.net - Source Control](https://supertuxkart.net/Source_control). *Note: Both `stk-code` and `stk-assets` **must** be in the same directory, otherwise the build will likely fail!* -3a. If you got the stable version, download the Windows dependencies package from [SuperTuxKart download area: Dependencies - SourceForge.net](https://sourceforge.net/projects/supertuxkart/files/SuperTuxKart%20Dependencies/Windows/) and unpack it. -3b. If you got the development version go to SuperTuxKart-dev in your file browser, right-click somewhere empty, select "Git clone..." and paste https://github.com/supertuxkart/dependencies.git in the URL field; click OK. When finished, copy the `dependencies` directory from either the `windows` or the `windows_64bit` directories into the `stk-code` directory; rename the latter to `dependencies-64bit` if you want to compile a 64-bit build. +4. If you got the stable version, download the Windows dependencies package from [SuperTuxKart download area: Dependencies - SourceForge.net](https://sourceforge.net/projects/supertuxkart/files/SuperTuxKart%20Dependencies/Windows/) and unpack it. -4. Download CMake from here: [CMake - download page](https://cmake.org/download/), install it; once CMake is installed, double click on the CMake icon on your desktop, and point it towards your `stk-code` directory in the 'Where is the source code' field, and point it to a new directory called `build` or `bld` inside the stk-code directory. +5. If you got the development version go to SuperTuxKart-dev in your file browser, right-click somewhere empty, select "Git clone..." and paste in the URL field; click OK. When finished, copy the `dependencies` directory from either the `windows` or the `windows_64bit` directories into the `stk-code` directory; rename the latter to `dependencies-64bit` if you want to compile a 64-bit build. -5. Press 'Configure'; CMake will ask you if it is OK to create the aforementioned directory, press `Yes`. CMake will then ask you about your version of Visual Studio. +6. Download CMake from here: [CMake - download page](https://cmake.org/download/), install it; once CMake is installed, double click on the CMake icon on your desktop, and point it towards your `stk-code` directory in the 'Where is the source code' field, and point it to a new directory called `build` or `bld` inside the stk-code directory. -Confirm your selection; *Please look at the table below to avoid confusion between version numbers and releases of Visual Studio*; CMake will begin creating the required files for the build in the directory. If you want to do a 64-bit build, select the version of Visual Studio you installed with "Win64" appended. +7. Press 'Configure'; CMake will ask you if it is OK to create the aforementioned directory, press `Yes`. CMake will then ask you about your version of Visual Studio. -6. Navigate to your build directory and open the `SuperTuxKart.sln` file; Visual Studio will now load the solution. + Confirm your selection; *Please look at the table below to avoid confusion between version numbers and releases of Visual Studio*; CMake will begin creating the required files for the build in the directory. If you want to do a 64-bit build, select the version of Visual Studio you installed with "Win64" appended. -7. In the 'Solution Explorer', right click on the `supertuxkart` project and select "Set as StartUp project". +8. Navigate to your build directory and open the `SuperTuxKart.sln` file; Visual Studio will now load the solution. -8. Open the 'Build' menu and select 'Build Solution'; or, press the default keyboard shortcut: `CTRL + SHIFT + B` to build the solution. +9. In the 'Solution Explorer', right click on the `supertuxkart` project and select "Set as StartUp project". + +10. Open the 'Build' menu and select 'Build Solution'; or, press the default keyboard shortcut: `CTRL + SHIFT + B` to build the solution. *Note: To avoid confusion between releases and versions, refer to this table:* @@ -158,27 +162,34 @@ Visual Studio 2015| 14 Visual Studio 2013| 13 ## Building SuperTuxKart on Windows (from PowerShell/Command line) + 1. Download and install Visual Studio from here: [Visual Studio - Download](https://www.visualstudio.com/downloads/), the free Visual Studio Community edition works fine. 2. Download a source package from either [SuperTuxKart 0.9.2 download area - SourceForge.net](https://sourceforge.net/projects/supertuxkart/files/SuperTuxKart/0.9.2) or [SuperTuxKart.net - Source Control](https://supertuxkart.net/Source_control) -NOTE: the `stk-code` and `stk-assets` directories **must** be in the same directory +NOTE: the `stk-code` and `stk-assets` directories **must** be in the same directory 3. Download the Windows dependencies package from either [SuperTuxKart download area - SourceForge.net](https://sourceforge.net/projects/supertuxkart/files/SuperTuxKart%20Dependencies/Windows/) or [SuperTuxKart on GitHub - Dependencies](https://github.com/supertuxkart/dependencies) and unpack the archive; once unpacked, copy the `dependencies` directory from either the `windows` or the `windows_64bit` directories into the `stk-code` directory 4. Download CMake from here: [CMake - download page](https://cmake.org/download/); and install it. Navigate to the `stk-code` directory; and create an directory called "build": -```cmd -mkdir build -cd build -``` + + ```cmd + mkdir build + cd build + ``` + 5. Once inside the build directory; run CMake to start the compilation process: -```cmd -cmake .. -``` + + ```cmd + cmake .. + ``` + 6. Now that CMake finished configuring and creating the necessary files for the build, run the build command in the same directory: + ```cmd -msbuild.exe SuperTuxKart.sln -``` -SuperTuxKart can now be run as `bin\Debug\supertuxkart.exe` or `bin\Release\supertuxkart.exe` +msbuild.exe SuperTuxKart.sln +``` + +SuperTuxKart can now be run as `bin\Debug\supertuxkart.exe` or `bin\Release\supertuxkart.exe` ## Building SuperTuxKart on macOS @@ -204,11 +215,12 @@ On OS X 10.9.5, you might need the following workaround: sudo ln -s `xcrun --show-sdk-path`/usr/include/ /usr/include sudo ln -s `xcrun --show-sdk-path`/System/Library/Frameworks/OpenGL.framework/Headers/ /usr/local/include/OpenGL ``` + The first link is required in order to find libcurl, the second to find opengl. ### STK 0.10 or later (or latest git) -Install homebrew (https://brew.sh/) +Install [homebrew](https://brew.sh/) Install all of the dependencies using homebrew: ```bash @@ -217,6 +229,7 @@ brew bundle ``` Build STK + ```bash mkdir cmake_build cd cmake_build @@ -226,7 +239,7 @@ make #### (Optional) packaging for distribution -By default, the executable that is produced is not ready for distribution. Install https://github.com/auriamg/macdylibbundler and run: +By default, the executable that is produced is not ready for distribution. Install and run: ```bash dylibbundler -od -b -x ./bin/SuperTuxKart.app/Contents/MacOS/supertuxkart -d ./bin/SuperTuxKart.app/Contents/libs/ -p @executable_path/../libs/ @@ -249,6 +262,7 @@ make ``` Building with GCC: + ```bash cd /path/to/stk-code mkdir cmake_build @@ -258,6 +272,7 @@ make ``` Building on 10.10 with 10.9 compatibility: + ```bash cmake .. -DCMAKE_OSX_SYSROOT=/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.9.sdk -DCMAKE_OSX_DEPLOYMENT_TARGET=10.9 ```