Skip to content

Commit b314640

Browse files
committed
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)
1 parent 795f314 commit b314640

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

INSTALL.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
#SuperTuxKart Installation Instructions
1+
# SuperTuxKart Installation Instructions
22

3-
Note : If you obtained this source code from github, you also need to download the game assets from sourceforge using SVN.
3+
Note: If you obtained this source code from Github, you also need to download the game assets from Sourceforge using SVN.
44

55
`svn checkout https://svn.code.sf.net/p/supertuxkart/code/stk-assets stk-assets`
66

77
Place the `stk-assets` folder next to the source root `stk-code` folder.
88
See <http://supertuxkart.sourceforge.net/Source_control> for more information
99

1010

11-
##Building STK on Linux
11+
## Building STK on Linux
1212

1313
First, make sure that you have the following packages installed:
1414

@@ -50,14 +50,18 @@ make VERBOSE=1 -j2
5050

5151
To create a debug version of STK, use:
5252

53-
`cmake .. -DCMAKE_BUILD_TYPE=Debug`
53+
```
54+
cmake .. -DCMAKE_BUILD_TYPE=Debug
55+
```
5456

5557
To test the compilation, supertuxkart can be run from the build
5658
directory by ./bin/supertuxkart
5759

5860
To install the file, as root execute:
5961

60-
`make install`
62+
```
63+
make install
64+
```
6165

6266
The default install location is `/usr/local`, i.e. the data files will
6367
be written to `/usr/local/share/games/supertuxkart`, the executable
@@ -66,9 +70,9 @@ location, specify `CMAKE_INSTALL_PREFIX` when running cmake, e.g.:
6670
`cmake .. -DCMAKE_INSTALL_PREFIX=/opt/stk`
6771

6872

69-
##Building STK on OS X
73+
## Building STK on OS X
7074
See <http://supertuxkart.sourceforge.net/Building_and_packaging_on_OSX>
7175

7276

73-
##Building STK on Windows
77+
## Building STK on Windows
7478
See <http://supertuxkart.sourceforge.net/How_to_build_the_Windows_version>

0 commit comments

Comments
 (0)