immibis
/
colobot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated INSTALL files

dev-ui
Piotr Dziwinski 2013-06-22 22:39:04 +02:00
parent 9f819088a6
commit 112d6843be
3 changed files with 22 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
INSTALL-MXE.txt → INSTALL-MXE.md
View File

@ -29,6 +29,7 @@ To cross-compile Colobot using MXE:
* check-requirements
* expat
* flac
* flac
* freetype
* gcc
* gcc-gmp
@ -39,24 +40,21 @@ To cross-compile Colobot using MXE:
* jpeg
* libiconv
* libpng
* libsndfile
* libtool
* mingwrt
* ogg
* openal
* portaudio
* sdl
* sdl_image
* sdl_ttf
* tiff
* vorbis
* w32api
* xz
* zlib
For optional audio support you'll need also:
* openal
* libsndfile
* ogg
* vorbis
* flac
4. Now `cd` to directory with colobot sources. To cross-compile a CMake project,
you have to specify a CMake toolchain file. MXE has such file in MXE's directory:
`usr/i686-pc-mingw32/share/cmake/mxe-conf.cmake`
@ -68,4 +66,4 @@ To cross-compile Colobot using MXE:
5. `make` should now compile the game with the resulting exe in `bin/colobot.exe`.
The exe is linked against all libraries *statically*, so there are no dependencies
on external DLLs. However, the resulting binary will be huge with all these libraries,
so you might want to do:`strip bin/colobot.exe`.
so you might want to do: `strip bin/colobot.exe`.

27
INSTALL.txt → INSTALL.md
View File

@ -6,8 +6,9 @@ Colobot source files can be downloaded from Github repository (https://github.co
the repository as a ZIP archive, or, clone the repository using git or a GUI frontent for git.
Make sure that once you download/clone the repository, you have the neeeded data files in `data/` subdirectory.These files
are provided as git submodule, hosted at a separate Github repository (https://github.com/colobot/colobot-data). If you
don't have them, download the repository and unpack its content into `data/`.
are provided as git submodule, hosted at a separate Github repository (https://github.com/colobot/colobot-data).
If you don't have them, you can either download the repository manually and unpack its content into `data/` or,
if you're working with git cloned repository, `git submodule update --init` will download the data submodule repository.
## Compiling on Windows
@ -24,18 +25,19 @@ When installing, select **all** possible packages in the installer.
Next, download the development package available at Colobot site (http://colobot.info/) and unpack the files
from the archive to MinGW directory. This should provide a working environment, including CMake and
all necessary packages.
all necessary packages. However, make sure you get the right package. There are slight changes between GCC 4.6 and 4.7,
especially with boost library which will result in build failure or error in runtime.
To compile Colobot, `cd` to directory with sources and run:
$ cmake -G "MSYS Makefiles" -DCMAKE_BUILD_TYPE=Release -DOPENAL_SOUND=1 .
$ cmake -G "MSYS Makefiles" -DCMAKE_BUILD_TYPE=Release .
and then:
$ make
Everything should compile just fine. If you see any errors, it most likely means missing libraries or invalid installation.
Warnings may occur, but are mostly harmless.
You'll get the binary in `bin/colobot.exe`, which you can run directly, pointing it to the data directory:
$ bin/colobot.exe -datadir ./data
You'll get the binary `colobot.exe`, which you can run directly, pointing it to the data directory:
$ colobot.exe -datadir ./data
You can also install Colobot in your system using
$ make install
@ -49,7 +51,7 @@ See also "Hints and notes" below on some useful advice.
MXE (http://mxe.cc/) is a very good cross-compiling framework, complete with a suite of libraries
that make it extremely easy to port applications to Win32. It runs on pretty much any *nix flavor and generates generic,
statically linked Win32 binaries. More information is available in INSTALL-MXE.txt file.
statically linked Win32 binaries. More information is available in INSTALL-MXE.md file.
## Compiling on Linux
@ -65,15 +67,13 @@ be different for different distros:
* GLEW >= 1.8.0
* libpng >= 1.2
* gettext >= 0.18
For optional sound support (`-DOPENAL_SOUND`):
* libsndfile >= 1.0.25
* libvorbis >= 1.3.2
* libogg >= 1.3.0
* OpenAL (OpenAL-Soft) >= 1.13 (optional)
* OpenAL (OpenAL-Soft) >= 1.13
Instructions for compiling are universal:
$ cmake -DCMAKE_BUILD_TYPE=Release -DOPENAL_SOUND=1 .
$ cmake -DCMAKE_BUILD_TYPE=Release .
$ make
Everything should compile just fine. If you see any errors, it most likely means missing libraries. Warnings may occur,
@ -107,8 +107,9 @@ This way, you can keep clean the directory with your source files. Example of us
$ make
If you want to submit debug reports, please use Debug builds (`-DCMAKE_BUILD_TYPE=Debug`) and run the game in debug mode and with
logging on higher level (commandline arguments: `-debug -loglevel debug`). Also, `-help` will give full list of available arguments.
If you want to submit debug reports, please use special Debug and Dev builds (`-DDEV_BUILD=1 -DCMAKE_BUILD_TYPE=Debug`)
and run the game in debug mode and with logging on higher level (commandline arguments: `-loglevel debug`).
Also, `-help` will give full list of available arguments.
If you encounter any problems, you can get help at our forum or IRC channels.

4
README.md
View File

@ -32,7 +32,7 @@ This will be a new installment in the Colobot series. We have many ideas for the
## Compiling and running the game
For these instructions see INSTALL.txt file.
For these instructions see INSTALL.md file.
## Contact
@ -79,7 +79,7 @@ To będzie nowa część z cyklu gier Colobot. Mamy wiele pomysłów na nową gr
## Kompilacja i uruchomienie gry
Instrukcje te znajdują się w pliku INSTALL.txt (po angielsku).
Instrukcje te znajdują się w pliku INSTALL.md (po angielsku).
## Kontakt