This directory contains files used for building and installing
on unix-like environments.
There's no need to use any of those directly; type './build.sh' from
the top dir to get started.

-= Instructions for cross-building UQM =-


Terminology:
	Build system
		The system on which the code is being built.
	Host system
		The system on which the code is supposed to run on.


Set the environment variable 'CROSS_ROOT' to the root of your cross building
environment. This is not necessary for the build scripts, but it will
simplify what you type in the following steps.

Make sure your cross-building tools (gcc, ld, etc) are in the path.
	export PATH=$CROSS_ROOT/bin:$PATH
Make sure that it isn't being reset by subshells that are started.
	unset ENV BASH_ENV

Set the environment variable 'BUILD_HOST' to the host system.
This is whatever 'uname -s' returns on such a system (like "MINGW32").
When building for Windows CE, using the cegcc tools, you should use "cegcc".

If your host system is big-endian, set the environment variable
'BUILD_HOST_ENDIAN' to "big". For a little-endian system, you don't
have to do anything.
	export BUILD_HOST_ENDIAN=little

If you're using pkg-config (advised), set the environment variable
PKG_CONFIG_PATH' to the pkgconfig directory of the cross environment.
This dir normally resides in the 'lib/' directory.
	export PKG_CONFIG_PATH=$CROSS_ROOT/lib/pkgconfig

For any libraries that can't be detected - which will be a lot if you
don't use pkg-config - set the corresponding include dirs in CFLAGS and
library dirs in LDFLAGS.
	export CFLAGS="-I$CROSS_ROOT/include"
	export LDFLAGS="-L$CROSS_ROOT/lib"

Run configure:
	./build.sh uqm config
This will produce the file 'build.vars' and 'config_unix.h' (or config_win.h
on MinGW or Cygwin). If there are any problems during the build, you can
usually easilly solve them by editing these files manually.

Start the compilation:
	./build.sh uqm

This file describes the easiest way to use this build system from
a packaging system such as rpm.

If you want an interactive configuration, you can start the build process
like you would do manually:
	./build.sh uqm
to build the game, and
	./build.sh uqm install
to install it.


If you want the configuration to be non-interactive, you'll want to do
the following: execute
	./build.sh uqm config
once. This will generate a 'config.vars' file, which you can then
include in your package. Then when you want to build the game, put this
file the directory pointed to by $BUILD_WORK (default is the current
directory), and do
	./build.sh uqm reprocess_config
to generate all the configuration information for the build, and then
	./build.sh uqm
to build the game, and
	./build.sh uqm install
to install it.

You may wish to set the environment variable BUILD_WORK to a directory
where the files created in the configuration and build process should be
stored. That way, the source tree will remain clean and no write access
to it is required.