Skip to content
Browse files

Aligned text to 80 chars width. Updated structure.

  • Loading branch information...
1 parent 909ce6e commit 01108720f056fac2029ef8c9f1e4b339622c541d @petarov committed Jun 28, 2013
Showing with 52 additions and 28 deletions.
  1. +52 −28 INSTALL
View
80 INSTALL
@@ -13,23 +13,29 @@ Get the latest source code from GitHub:
git clone git://github.com/petarov/savagewheels.git savagewheels
Get the data files archive 'savagewheels-gamedata.tar.gz' from
-https://code.google.com/p/savagewheels. Extract the downloaded archive into the bin/ folder.
+https://code.google.com/p/savagewheels. Extract the downloaded archive into
+the bin/ folder.
This archive should contain the folders: autos/, graphics/ and sounds/.
3) Installation on Linux platforms
3.1) Requirements:
* CMake 2.8.x
- * libSDL 1.2.x - You should install libSDL using your package manager.
- * FMod Ex API 4.x - Install using your package manager or get the package from FMod's website.
- * (Ubuntu specific) Install 'build-essential' package.
+ * (Ubuntu specific) Install package 'build-essential'.
+ * libSDL >= 1.2.11 - You should install it using your package manager.
+ * For music support either:
+ - SDL_Mixer >= 1.2.12 - You should install it using your package manager.
+ or
+ - FMod Ex API 4.x - Install using your package manager or get the package
+ from FMod's website.
-3.2) Instructions
+3.2) Compile & Build
- a) Install the libSDL package using the package manager on your Linux distribution.
+ a) Install the libSDL package using the package manager on your Linux
+ distribution.
- b) Install the FMod Ex package using the package manager on your Linux distribution or get
- the package from FMod's website.
+ b) Install the FMod Ex package using the package manager on your Linux
+ distribution or get the package from FMod's website.
c) Run the build script - build.sh
$ ./build.sh
@@ -42,10 +48,11 @@ This archive should contain the folders: autos/, graphics/ and sounds/.
or
$ ./run.sh
- The 'run.sh' script will attempt to set the LD_LIBRARY_PATH in case you are missing libSDL
- or FModEx shared object libraries.
+ The 'run.sh' script will attempt to set the LD_LIBRARY_PATH in case you
+ are missing libSDL or FModEx shared object libraries.
- If you experience problems with the automated 'build.sh' script you can try to build manually.
+ If you experience problems with the automated 'build.sh' script you can
+ try to build manually.
a) You can also run CMake manually. Go to the release/ sub folder and run.
$ cmake -G "Unix Makefiles" ../ -DCMAKE_BUILD_TYPE:STRING=Release
@@ -59,7 +66,20 @@ This archive should contain the folders: autos/, graphics/ and sounds/.
c) Create the installation package with:
$ cpack
-3.3) Packaging
+3.2.1) Sound libraries support
+
+ TODO
+
+3.2.2) Compile 32-bit version on 64-bit Linux
+
+ This requires that you have the 'gcc-multilib' package installed on your
+ system. You will also need to have 32-bit versions of libSDL.so and
+ libfmodex.so.
+
+ After all required packages are installed build the makefile by running:
+ $ cmake -G "Unix Makefiles" ../ -DCMAKE_BUILD_TYPE:STRING=Release -DM32=1
+
+3.4) Packaging
A self-extracting STGZ file will be created by default when running:
$ cpack
@@ -72,28 +92,28 @@ This archive should contain the folders: autos/, graphics/ and sounds/.
This will create a .deb package that you can install with, e.g.,
$ dpkg -i savagewheels-1.5.0-Linux-x64.deb
-3.4) Compile 32-bit version on 64-bit Linux
-
- This requires that you have the 'gcc-multilib' package installed on your system.
- You will also need to have 32-bit versions of libSDL.so and libfmodex.so.
-
- After all required packages are installed build the makefile by running:
- $ cmake -G "Unix Makefiles" ../ -DCMAKE_BUILD_TYPE:STRING=Release -DM32=1
-
4) Installation on Windows
4.1) Requirements
* MinGW (Minimalist GNU for Windows). I have only tested with Mingw32.
* CMake 2.8.x
- * libSDL 1.2.x - Download the Development Libraries archive.
- * FMod Ex API 4.x - Download and install the FMOD Ex API installer EXE from www.fmod.org.
-
-4.2) Instructions
+ * libSDL >= 1.2.11 - Download the Development Libraries archive from
+ http://www.libsdl.org/download-1.2.php.
+ * For music support either:
+ - SDL_Mixer >= 1.2.12 - Download the binary SDL_mixer-1.2.x-win32.zip
+ package and the source SDL_mixer-1.2.x.zip package from
+ http://www.libsdl.org/projects/SDL_mixer/.
+ or
+ - FMod Ex API 4.x - Download and install the FMOD Ex API installer EXE
+ from www.fmod.org.
+
+4.2) Compile & Build
a) Extract the contents of SDL 1.2.x package into the libs/ subfolder.
Set the environment variable SDLDIR=<SDL-directory-in-libs>.
- b) Install the FMod Ex API and copy the api/ folder into the libs/ subfolder.
+ b) Install the FMod Ex API and copy the api/ folder into the libs/
+ subfolder.
c) Run CMake manually. Go to the release/ sub folder and run.
> cmake -G "MinGW Makefiles" ../ -DCMAKE_BUILD_TYPE:STRING=Release
@@ -107,13 +127,17 @@ This archive should contain the folders: autos/, graphics/ and sounds/.
d) Create the installation package with:
> cpack
- c) Extract the produced archive file, e.g., savagewheels-1.5.0-Windows-x86.tar.gz to your
- desired Games folder.
+ c) Extract the produced archive file, e.g.,
+ savagewheels-1.5.0-Windows-x86.tar.gz to your desired Games folder.
e) Start the game with:
> savagewheels
-5) Compiling a Debug version
+4.2.1) Sound libraries support
+
+
+
+4.2.2) Compiling a Debug version
To build a Debug version to catch a bug or something use the following:

0 comments on commit 0110872

Please sign in to comment.
Something went wrong with that request. Please try again.