summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/INSTALL/ubuntu.txt43
-rw-r--r--docs/SOURCE/Doxyfile4
2 files changed, 45 insertions, 2 deletions
diff --git a/docs/INSTALL/ubuntu.txt b/docs/INSTALL/ubuntu.txt
new file mode 100644
index 00000000..cf830ccc
--- /dev/null
+++ b/docs/INSTALL/ubuntu.txt
@@ -0,0 +1,43 @@
+How to build a .deb for TMW on Ubuntu
+=====================================
+
+This documentation is for those who are interested in building the .deb files
+of The Mana World. Most people do not need to do this, but can instead use the
+repository. You can find information about how to use the repository on our
+downloads page.
+
+
+1. Installing the dependencies
+==============================
+
+First of all you need a working compiler and package building environment. If
+you don't have this yet, install the following packages:
+
+ apt-get install gcc g++ dh-make fakeroot dpkg-dev build-essentials
+
+In order to compile The Mana World, you'll need the developer packages for
+SDL, SDL_mixer, SDL_image, SDL_net, libxml2, libphysfs and libguichan0.
+
+ apt-get install libsdl1.2-dev libsdl-mixer1.2-dev libsdl-image1.2-dev ...
+
+(todo: add missing entries)
+(todo: include information about installing Guichan development package)
+
+
+2. Creating the .debs using DebHelper Tools
+===========================================
+
+Either download the source release of TMW that you want to build a package for,
+or check out the appropriate version from Subversion, for example by using the
+tag.
+
+Make sure the files in the debian directory are up to date. You can do this by
+checking out the appropriate directory from Subversion (will be either
+tmw/branches/0.0/debian or tmw/trunk/debian for the latest release).
+
+Now we can build the packages using the following command.
+
+ fakeroot dpkg-buildpackage
+
+The packages will be created in the parent folder.
+
diff --git a/docs/SOURCE/Doxyfile b/docs/SOURCE/Doxyfile
index c9522aaf..96541dc8 100644
--- a/docs/SOURCE/Doxyfile
+++ b/docs/SOURCE/Doxyfile
@@ -17,7 +17,7 @@
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
-PROJECT_NAME = The Mana World
+PROJECT_NAME = "The Mana World"
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
@@ -1085,7 +1085,7 @@ CALL_GRAPH = NO
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
# will graphical hierarchy of all classes instead of a textual one.
-GRAPHICAL_HIERARCHY = YES
+GRAPHICAL_HIERARCHY = NO
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot. Possible values are png, jpg, or gif