Development:QuickStart: Difference between revisions

Revision as of 22:15, 22 May 2009

Quickstart Guide

A step-by-step document on how to build the whole thing would help new users to get started, help new programmers understand the dependencies, and help experienced developers see places the process could be improved.

Warning

The most of this tutorial is just text, commands are initiated by a dollar sign ($)
If you copy and paste the commands, let the $ out.

Preparation of the development environment

Make sure you installed needed software! You need:

cvs
doxygen
and the stuff mentioned by the Dependency Matrix.

Debian users will use aptitude or apt-get. SuSE users have YaST.

Prepare a new working directory. Lets assume /home/enrico/vanilla_adonthell to be the working dir in this tutorial. If your username is not enrico, adapt it to your needs.

Obtaining the code

Change to the working directory and execute

$ cvs -z6 -d:pserver:[email protected]:/sources/adonthell co adonthell

(more info here)

Congratulation, now you got the sourcecode. The tricky part begins.

Compilation

assuming you are in /home/enrico/vanilla_adonthell

$ mkdir adonthell-build && cd adonthell-build
$ cmake -DCMAKE_INSTALL_PREFIX=/usr/local ../adonthell
$ make

Beware if you are using cmake prior to version 2.6; compilation might fail unless you remove previously installed versions of Adonthell 0.4:

$ sudo rm /usr/local/lib/libadonthell_*

Please note: If you intend to compile the Adonthell Tools, you shouldn't use the cmake build, or you might run into compatibility issues. Use the GNU autotools based build instead, which is described in the detailted compilation instructions.

Installation

make sure you are in /home/enrico/vanilla_adonthell/adonthell-build

$ sudo make install

or as superuser

$# make install

Test

make sure you are in /home/enrico/vanilla_adonthell/adonthell-build

$ test/worldtest -g ../adonthell/test/

the previous command should present a small demo

Troubleshooting

Workarounds for known problems during the build and when running Adonthell are listed here.

Doc

has to be created change dir to ../adonthell/doc/ and execute

$ doxygen reference.cfg

API-doc is now in /home/enrico/vanilla_adonthell/adonthell/doc/adonthell-api/index.html

A slightly outdated version is available online. It is usually updated after larger changes to the code have taken place.

@@ Line 47: / Line 47: @@
   $ sudo rm /usr/local/lib/libadonthell_*
-(More detailed [[Development:Compiling|compilation instructions]])
+{| border=1 cellspacing=0 cellpadding=5 align=center width=100%
+|- style="background:#c38e64; text-align:left"
+| '''Please note:''' If you intend to compile the [[Tools:Contents|Adonthell Tools]], you shouldn't use the cmake build, or you might run into compatibility issues. Use the GNU autotools based build instead, which is described in the detailted [[Development:Compiling|compilation instructions]].
+|}
 === Installation ===