summaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL77
1 files changed, 77 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 000000000..46836c212
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,77 @@
+How to compile and run Mana on your GNU/Linux Box
+=================================================
+
+Homepage: http://manasource.org/
+IRC: irc.freenode.net / #manasource
+
+1) Requirements
+2) Compiling And Installing Mana
+3) Notes
+
+
+1. Requirements
+===============
+
+You are expected to have either checked out Mana from Git or you have downloaded
+a source release. To get Mana to compile, you need a compiler (GCC)
+and some libraries. The required libraries are:
+
+* SDL http://www.libsdl.org/
+* SDL_mixer http://www.libsdl.org/projects/SDL_mixer/
+* SDL_image http://www.libsdl.org/projects/SDL_image/
+* SDL_net http://www.libsdl.org/projects/SDL_net/
+* SDL_ttf http://www.libsdl.org/projects/SDL_ttf/
+* SDL_gfx http://www.ferzkopp.net/joomla/software-mainmenu-14/4-ferzkopps-linux-software/19-sdlgfx
+* ENet 1.2 http://enet.bespin.org/
+* Guichan 0.8.x http://guichan.sourceforge.net/
+* libxml2 http://www.xmlsoft.org/
+* physfs 1.x http://icculus.org/physfs/
+* zlib 1.2.x http://www.gzip.org/zlib/
+* libcurl http://curl.haxx.se/libcurl/
+
+If you've cloned the Git repository, you will also need these tools to compile:
+
+* GNU automake 1.9 http://www.gnu.org/software/automake/
+* GNU autoconf http://www.gnu.org/software/autoconf/
+* GNU gettext http://www.gnu.org/software/gettext/
+* CVS http://www.nongnu.org/cvs/ (needed to run autopoint)
+
+On some machines, it's been reported that this package is also needed. However,
+you might not need it:
+
+* GNU libtool http://www.gnu.org/software/libtool/
+
+Installing these dependencies is distributions-specific, and we'll leave it to
+you to figure this out.
+
+
+2. Compiling And Installing Mana
+================================
+
+1) Go to the directory you have extracted the source to.
+2) If you've cloned the Git repository, run "autoreconf -i" to generate
+ configure and install any missing auxiliary files.
+3) Run "./configure"
+4) Run "make"
+5) Run "make install" as root
+
+It should have installed Mana on your system now, and you can run it
+with "mana". By default all files are installed to /usr/local, you can pass a
+different prefix to configure as usual.
+
+
+ NOTE: It is possible to compile Mana without support for OpenGL rendering.
+ To do this perform step 3 as follows:
+
+ ./configure --without-opengl
+
+ Rebuild the executable from scratch using "make clean" and then "make".
+
+
+3. Notes
+========
+
+If you have any problems, you are welcome to post your questions on our forums,
+or talk about them in our IRC channel.
+
+- Mana Dev Team