ilikecats/stk-code_catmod
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
1260f23db0
stk-code_catmod/INSTALL.md

83 lines
2.0 KiB
Markdown
Raw Normal View History

Update INSTALL.md * correct spaces * proper names with a capital letter * also use block code indentation for single-line commands to keep a consistent look (`this code style` should only be used for code/commands mentioned inside of other text)
2015-11-03 17:21:08 -05:00
# SuperTuxKart Installation Instructions
INSTALL rewritten in Markdown. Note: This commit maybe needs a correction because the Ubuntu command is very long.
2014-01-17 11:02:53 -05:00
Update dependencies for Ubuntu - use officially supported pkg-config instead of pkgconf replacement - add zlib library to dependencies - remove GLU library which is not needed at all since this commit: 60dc171700e75a146a7c28169603e535f2679259 - add libgl1-mesa-dev and mesa-common-dev which contains OpenGL headers that we need - use libcurl-gnutls instead of openssl because it is used by default in Debian/Ubuntu for STK and many other projects.
2016-05-14 17:17:13 -04:00
Note: If you obtained this source code from Github, you also need to download
the game assets from Sourceforge using SVN.
INSTALL rewritten in Markdown. Note: This commit maybe needs a correction because the Ubuntu command is very long.
2014-01-17 11:02:53 -05:00
`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.
Update more links (#2530)
2016-06-28 18:27:15 -04:00
See <https://supertuxkart.net/Source_control> for more information
INSTALL rewritten in Markdown. Note: This commit maybe needs a correction because the Ubuntu command is very long.
2014-01-17 11:02:53 -05:00
Update INSTALL.md * correct spaces * proper names with a capital letter * also use block code indentation for single-line commands to keep a consistent look (`this code style` should only be used for code/commands mentioned inside of other text)
2015-11-03 17:21:08 -05:00
## Building STK on Linux
INSTALL rewritten in Markdown. Note: This commit maybe needs a correction because the Ubuntu command is very long.
2014-01-17 11:02:53 -05:00
First, make sure that you have the following packages installed:
* OpenGL (mesa)
* OpenAL (recommended: openal-soft-devel)
* Ogg (libogg-dev)
* Vorbis (libvorbis-dev)
Add freetype into INSTALL.md
2016-04-24 21:18:37 -04:00
* Freetype (libfreetype6-dev)
INSTALL rewritten in Markdown. Note: This commit maybe needs a correction because the Ubuntu command is very long.
2014-01-17 11:02:53 -05:00
* libcurl (libcurl-devel)
* libbluetooth (bluez-devel)
Update INSTALL.md
2015-01-18 20:44:10 -05:00
* libpng (libpng-devel)
* zlib (zlib-devel)
* jpeg (libjpeg-turbo-devel)
INSTALL rewritten in Markdown. Note: This commit maybe needs a correction because the Ubuntu command is very long.
2014-01-17 11:02:53 -05:00
Ubuntu command:
Using GitHub Flavored Markdown in INSTALL.md to fix some mistakes from commit b903f8788c
2014-01-17 12:31:15 -05:00
```
Update dependencies for Ubuntu - use officially supported pkg-config instead of pkgconf replacement - add zlib library to dependencies - remove GLU library which is not needed at all since this commit: 60dc171700e75a146a7c28169603e535f2679259 - add libgl1-mesa-dev and mesa-common-dev which contains OpenGL headers that we need - use libcurl-gnutls instead of openssl because it is used by default in Debian/Ubuntu for STK and many other projects.
2016-05-14 17:17:13 -04:00
sudo apt-get install build-essential cmake libbluetooth-dev \
libcurl4-gnutls-dev libfreetype6-dev libfribidi-dev libgl1-mesa-dev \
libjpeg-dev libogg-dev libopenal-dev libpng-dev libvorbis-dev libxrandr-dev \
mesa-common-dev pkg-config zlib1g-dev
Using GitHub Flavored Markdown in INSTALL.md to fix some mistakes from commit b903f8788c
2014-01-17 12:31:15 -05:00
```
INSTALL rewritten in Markdown. Note: This commit maybe needs a correction because the Ubuntu command is very long.
2014-01-17 11:02:53 -05:00
Unpack the files from the tarball like this:
Using GitHub Flavored Markdown in INSTALL.md to fix some mistakes from commit b903f8788c
2014-01-17 12:31:15 -05:00
```
tar xzf supertuxkart-*.tar.gz
cd supertuxkart-*
```
INSTALL rewritten in Markdown. Note: This commit maybe needs a correction because the Ubuntu command is very long.
2014-01-17 11:02:53 -05:00
where `*` is the version of SuperTuxkart you downloaded - eg `0.8.0`. Then:
Compile SuperTuxKart:
Using GitHub Flavored Markdown in INSTALL.md to fix some mistakes from commit b903f8788c
2014-01-17 12:31:15 -05:00
```
mkdir cmake_build
cd cmake_build
cmake ..
make VERBOSE=1 -j2
```
INSTALL rewritten in Markdown. Note: This commit maybe needs a correction because the Ubuntu command is very long.
2014-01-17 11:02:53 -05:00
To create a debug version of STK, use:
Update INSTALL.md * correct spaces * proper names with a capital letter * also use block code indentation for single-line commands to keep a consistent look (`this code style` should only be used for code/commands mentioned inside of other text)
2015-11-03 17:21:08 -05:00
```
cmake .. -DCMAKE_BUILD_TYPE=Debug
```
INSTALL rewritten in Markdown. Note: This commit maybe needs a correction because the Ubuntu command is very long.
2014-01-17 11:02:53 -05:00
To test the compilation, supertuxkart can be run from the build
directory by ./bin/supertuxkart
To install the file, as root execute:
Update INSTALL.md * correct spaces * proper names with a capital letter * also use block code indentation for single-line commands to keep a consistent look (`this code style` should only be used for code/commands mentioned inside of other text)
2015-11-03 17:21:08 -05:00
```
make install
```
INSTALL rewritten in Markdown. Note: This commit maybe needs a correction because the Ubuntu command is very long.
2014-01-17 11:02:53 -05:00
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`
Update INSTALL.md * correct spaces * proper names with a capital letter * also use block code indentation for single-line commands to keep a consistent look (`this code style` should only be used for code/commands mentioned inside of other text)
2015-11-03 17:21:08 -05:00
## Building STK on OS X
Update more links (#2530)
2016-06-28 18:27:15 -04:00
See <https://supertuxkart.net/Building_and_packaging_on_OSX>
INSTALL rewritten in Markdown. Note: This commit maybe needs a correction because the Ubuntu command is very long.
2014-01-17 11:02:53 -05:00
Update INSTALL.md * correct spaces * proper names with a capital letter * also use block code indentation for single-line commands to keep a consistent look (`this code style` should only be used for code/commands mentioned inside of other text)
2015-11-03 17:21:08 -05:00
## Building STK on Windows
Update more links (#2530)
2016-06-28 18:27:15 -04:00
See <https://supertuxkart.net/How_to_build_the_Windows_version>
Reference in New Issue Copy Permalink