ilikecats/stk-code_catmod
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README rewritten in Markdown. Fixed some minor mistakes too.

Browse Source
This commit is contained in:
Max Teufel 2014-01-15 18:20:53 +01:00 committed by Arthur-D
parent c622ba258c
commit 4dd5ab3b65
1 changed files with 20 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
README → README.md
View File

@ -1,41 +1,31 @@
SuperTuxKart #SuperTuxKart
============
SuperTuxKart is a free kart racing game. It is focusing on fun and SuperTuxKart is a free kart racing game. It is focusing on fun and
not on realistic kart physics. Instruction can be found on the not on realistic kart physics. Instruction can be found on the
in-game help page. in-game help page.
The SuperTuxKart homepage can be found at: The SuperTuxKart homepage can be found at: <http://supertuxkart.sourceforge.net>
http://supertuxkart.sourceforge.net The official SuperTuxKart forum is at <http://supertuxkart.sourceforge.net/forum>. If you need support,
The official SuperTuxKart forum is at. If you need support,
this would be the best place to start. this would be the best place to start.
http://supertuxkart.sourceforge.net/forum
Hope you enjoy the game. Hope you enjoy the game.
- The SuperTuxKart development team.
-- The SuperTuxKart development team.
HARDWARE REQUIREMENTS ##Hardware Requirements
===================== * You need a 3D graphics card. (NVIDIA GeForce 8xxx and higher, ATI Radeon HD 4xxx and higher or Intel HD 3000 and higher)
* You need a 3D graphics card.
NVIDIA GeForce 8xxx and higher
ATI Radeon HD 4xxx and higher
Intel HD 3000 and higher
* You should have a CPU that's running at 1GHz or better. * You should have a CPU that's running at 1GHz or better.
* You'll need at least 512 MB of free VRAM (video memory). * You'll need at least 512 MB of free VRAM (video memory).
* Disk space: 400MB * Disk space: 400MB
* Ideally, you want a joystick with at least 6 buttons. * Ideally, you want a joystick with at least 6 buttons.
COMPILING SuperTuxkart ##Compiling SuperTuxKart
======================
WINDOWS ###Windows
-------
A project file for Visual Studio 9 (e.g. the free 2008 express A project file for Visual Studio 9 (e.g. the free 2008 express
edition) is included in the sources in src/ide/vc9. A separate edition) is included in the sources in `src/ide/vc9`. A separate
dependency package is available on SuperTuxKart's sourceforge dependency package is available on SuperTuxKart's sourceforge
page, which includes all necessary libraries, header files, page, which includes all necessary libraries, header files,
and dlls to compile and run the source code. and dlls to compile and run the source code.
@ -43,36 +33,30 @@ and dlls to compile and run the source code.
While compilation with cygwin is not officially supported, While compilation with cygwin is not officially supported,
this has been done (check with the forum for details). this has been done (check with the forum for details).
MAC OSX ###Mac OS X
-------
The latest information about compilation on Mac are on our wiki: The latest information about compilation on Mac are on our wiki:
http://supertuxkart.sourceforge.net/Building_and_packaging_on_OSX <http://supertuxkart.sourceforge.net/Building_and_packaging_on_OSX>
The Xcode project file is in /src/ide/Xcode/, but it still The Xcode project file is in `/src/ide/Xcode/`, but it still
requires that all dependencies are installed as explained on the wiki. requires that all dependencies are installed as explained on the wiki.
UNIX ###UNIX
---- See `INSTALL` for details.
See INSTALL for details.
LICENSE ##License
=======
This software is released under the GNU General Public License (GPL) which This software is released under the GNU General Public License (GPL) which
can be found in the file 'LICENSE' in the same directory as this file. can be found in the file `LICENSE` in the same directory as this file.
Information about the licenses for artwork are contained in Information about the licenses for artwork are contained in
data/licenses. `data/licenses`.
3D COORDINATES ##3D coordinates
==============
A reminder for those looking at the code and 3d models: A reminder for those looking at the code and 3d models:
STK : X right, Y up, Z forwards STK : X right, Y up, Z forwards
Blender: X right, Y forwards, Z up Blender: X right, Y forwards, Z up
The exporters perform the needed transform, so in Blender you just work The exporters perform the needed transform, so in Blender you just work
with XY plane as ground, and things will appear fine in STK (using XZ with XY plane as ground, and things will appear fine in STK (using XZ
as ground in the code, obviously). as ground in the code, obviously).