diff options
author | Bardur Arantsson <bardur@scientician.net> | 2010-07-31 12:12:16 +0200 |
---|---|---|
committer | Bardur Arantsson <bardur@scientician.net> | 2010-07-31 12:37:03 +0200 |
commit | b375a6922e5112fb3a012cbaae42106549411726 (patch) | |
tree | cd0a8f13fbd2d033194cc05cfef9b6ac65f289d5 /README.txt | |
parent | 5e579f83d220a219c838ebe99d65a1cd1a2989d5 (diff) |
Rename "building.txt" to "README.txt" and add "BUGS.txt".
Diffstat (limited to 'README.txt')
-rw-r--r-- | README.txt | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/README.txt b/README.txt new file mode 100644 index 00000000..463d648c --- /dev/null +++ b/README.txt @@ -0,0 +1,82 @@ +Using the CMake build system +============================ + +There are basically two options for how to run ToME once built. + + + +Option #1 : Run ToME from the build directory +============================================= + +Simply run the commands below. + + $ cmake . + $ make + +You should now be able to run + + $ ./src/tome2 + +to start ToME. + +This is currently the recommended option. + + + +Option #2: Run ToME from a system install location +================================================== + +Run + + $ cmake -DSYSTEM_INSTALL:BOOL=true . + $ make + $ sudo make install + +You can now run ToME from anywhere. + +You can also use DESTDIR when installing to a different location +(useful with e.g. stow or when building distribution packages). + + +Compiling on Ubuntu +=================== + +If you're having trouble compiling on an Ubuntu install you are +probably missing the + + build-essential + +package. + +Each frontend requires the additional packages listed below: + + X11: libx11-dev + SDL: libsdl-image1.2-dev, libsdl-ttf2.0-dev + ncurses: libncurses5-dev + + +Compiling on OpenBSD +==================== + +As of February 2010, the OpenBSD package cmake-2.4.8p2 is too old for +building ToME. You may need to compile a newer version of CMake. + +If you have X11, then a bug in CMake may cause a linker error when +linking the 'tome' executable. As a workaround, set the environment +variable LDFLAGS=-L/usr/X11R6/lib when running CMake. Example: + + $ env LDFLAGS=-L/usr/X11R6/lib cmake . + $ make + +The SDL frontend also requires these packages: sdl-image, sdl-ttf + + +Compiling on Windows using MinGW +================================ + +(See http://www.mingw.org/) + +To compile on Windows using MinGW, use the commands + + $ cmake -G "MinGW Makefiles" + $ mingw32-make |