From b903f8788cd9084b3e7b89e8bd6c65d005ff55b3 Mon Sep 17 00:00:00 2001 From: Max Teufel Date: Fri, 17 Jan 2014 17:02:53 +0100 Subject: [PATCH] INSTALL rewritten in Markdown. Note: This commit maybe needs a correction because the Ubuntu command is very long. --- INSTALL | 62 -------------------------------------------------- INSTALL.md | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 67 insertions(+), 62 deletions(-) delete mode 100644 INSTALL create mode 100644 INSTALL.md diff --git a/INSTALL b/INSTALL deleted file mode 100644 index b329fd6b5..000000000 --- a/INSTALL +++ /dev/null @@ -1,62 +0,0 @@ -SUPERTUXKART INSTALLATION INSTRUCTIONS -====================================== - -Note : If you obtained this source code from github, you also need to download the game assets from sourceforge using SVN. - svn checkout https://svn.code.sf.net/p/supertuxkart/code/stk-assets stk-assets -Place the stk-assets folder next to the source root stk-code folder. -See http://supertuxkart.sourceforge.net/Source_control for more information - - -Building STK on Linux --------------------- - -First, make sure that you have the following packages installed: - - * OpenGL (mesa) - * OpenAL (recommended: openal-soft-devel) - * Ogg (libogg-dev) - * Vorbis (libvorbis-dev) - * libcurl (libcurl-devel) - * libbluetooth (bluez-devel) - -Ubuntu command : - sudo apt-get install autoconf automake build-essential cmake libogg-dev libvorbis-dev libopenal-dev libxxf86vm-dev libgl1-mesa-dev libglu1-mesa-dev libcurl4-openssl-dev libfribidi-dev libbluetooth-dev - -Unpack the files from the tarball like this: - - tar xzf supertuxkart-*.tar.gz - cd supertuxkart-* - -where '*' is the version of SuperTuxkart you downloaded - eg 0.8.0. Then: - - -* Compile SuperTuxKart: - mkdir cmake_build - cd cmake_build - cmake .. - make VERBOSE=1 -j2 - To create a debug version of STK, use: - cmake .. -DCMAKE_BUILD_TYPE=Debug - -To test the compilation, supertuxkart can be run from the build -directory by ./bin/supertuxkart - -To install the file, as root execute: - - make install - -The default install location is /usr/local, i.e. the data files will -be written to /usr/local/share/games/supertuxkart, the executable -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 STK on OS X --------------------- -See http://supertuxkart.sourceforge.net/Building_and_packaging_on_OSX - - -Building STK on Windows ------------------------ -See http://supertuxkart.sourceforge.net/How_to_build_the_Windows_version diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 000000000..8279636ce --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,67 @@ +#SuperTuxKart Installation Instructions + +Note : If you obtained this source code from github, you also need to download the game assets from sourceforge using SVN. + +`svn checkout https://svn.code.sf.net/p/supertuxkart/code/stk-assets stk-assets` + +Place the `stk-assets` folder next to the source root `stk-code` folder. +See for more information + + +##Building STK on Linux + +First, make sure that you have the following packages installed: + + * OpenGL (mesa) + * OpenAL (recommended: openal-soft-devel) + * Ogg (libogg-dev) + * Vorbis (libvorbis-dev) + * libcurl (libcurl-devel) + * libbluetooth (bluez-devel) + +Ubuntu command: + +`sudo apt-get install autoconf automake build-essential cmake libogg-dev libvorbis-dev libopenal-dev libxxf86vm-dev libgl1-mesa-dev libglu1-mesa-dev libcurl4-openssl-dev libfribidi-dev libbluetooth-dev` + +Unpack the files from the tarball like this: + +`tar xzf supertuxkart-*.tar.gz +cd supertuxkart-*` + +where `*` is the version of SuperTuxkart you downloaded - eg `0.8.0`. Then: + + +Compile SuperTuxKart: + +`mkdir cmake_build` + +`cd cmake_build` + +`cmake ..` + +`make VERBOSE=1 -j2` + +To create a debug version of STK, use: + +`cmake .. -DCMAKE_BUILD_TYPE=Debug` + +To test the compilation, supertuxkart can be run from the build +directory by ./bin/supertuxkart + +To install the file, as root execute: + +`make install` + +The default install location is `/usr/local`, i.e. the data files will +be written to `/usr/local/share/games/supertuxkart`, the executable +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 STK on OS X +See + + +##Building STK on Windows +See