From ed0cf4ea342208c8329f3630d255834768eb5809 Mon Sep 17 00:00:00 2001 From: rugk Date: Tue, 3 Nov 2015 23:16:53 +0100 Subject: [PATCH] Readme improvments * added space afer `#` headline * corrected file names of files I could find * linked to files However one thing I could not fix was this sentence: "Information about the licenses for artwork are contained in `data/licenses`." The mentioned file or dir does not exist (anymore) and I could not find any other file, which would fit there. --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 6d98155f8..27ff5a639 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -#SuperTuxKart +# SuperTuxKart [![Build Status](https://travis-ci.org/supertuxkart/stk-code.png?branch=master)](https://travis-ci.org/supertuxkart/stk-code) SuperTuxKart is a free kart racing game. It is focusing on fun and @@ -15,7 +15,7 @@ Hope you enjoy the game. -- 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 should have a CPU that's running at 1GHz or better. * You'll need at least 512 MB of free VRAM (video memory). @@ -23,9 +23,9 @@ Hope you enjoy the game. * Ideally, you want a joystick with at least 6 buttons. -##Compiling SuperTuxKart +## Compiling SuperTuxKart -###Windows +### Windows 1. Install VS 2013 (or later). The free express versions work fine. 2. Download and install a source package - either a released package or from our [git/svn repositories](http://supertuxkart.sourceforge.net/Source_control) 3. Download the latest dependency package depdendencies_for_0.8.2.zip from [here](https://sourceforge.net/projects/supertuxkart/files/SuperTuxKart%20Dependencies/Windows/). Unzip it in the root directory, so that the dependencies directory is next to the src and data directory (if you are updating from a previous dependency package, you can delete the .dll files in the root directory, they are not needed anymore). @@ -38,24 +38,24 @@ Hope you enjoy the game. Compilation with cygwin is not officially supported, but this has been done (check with the forum for details). -###Mac OS X +### Mac OS X The latest information about compilation on Mac are on our wiki: The Xcode project file is in `/src/ide/Xcode/`, but it still requires that all dependencies are installed as explained on the wiki. -###UNIX -See `INSTALL` for details. +### UNIX +See [`INSTALL.md`](INSTALL.md) for details. -##License +## License 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 [`COPYING`](/COPYING) in the same directory as this file. Information about the licenses for artwork are contained in `data/licenses`. -##3D coordinates +## 3D coordinates A reminder for those looking at the code and 3d models: STK : X right, Y up, Z forwards