Development:QuickStart: Difference between revisions

Latest revision as of 10:11, 26 February 2012

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:

git (for obtaining the source code)
doxygen and graphviz (to generate the API documentation)
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 your working directory and execute (more info here):

$ git clone git://github.com/ksterker/adonthell.git

Congratulation, now you got the source code in a subdirectory called adonthell. 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

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/ data

the previous command should present a small demo

Troubleshooting

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

Doc

To create the source code documentation, you will need doxygen and dot, which is part of the graphviz package.

Change directory 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 13: / Line 13: @@
 Make sure you installed needed software!
 You need:
-* cvs
+* [http://www.git-scm.com/ git] (for obtaining the source code)
-* doxygen
+* [http://www.doxygen.org doxygen] and [http://www.graphviz.org graphviz] (to generate the API documentation)
-* and the stuff mentioned by the Dependency Matrix.
+* and the stuff mentioned by the [[Development:Dependency Matrix|Dependency Matrix]].
-(look at
-http://adonthell.berlios.de/doc/index.php/Development:Dependency_Matrix)<br>
 Debian users will use aptitude or apt-get.
 SuSE users have YaST.
@@ Line 27: / Line 26: @@
 === Obtaining the code ===
-Change to the working directory and execute<br>
-$ cvs -z6 -d:pserver:[email protected]:/sources/adonthell co adonthell<br>
+Change to your working directory and execute (more info [[Development:GIT|here]]):
-(more info at
+ $ git clone git://github.com/ksterker/adonthell.git
-http://adonthell.berlios.de/doc/index.php/Development:CVS)<br>
-Congratulation, now you got the sourcecode. The tricky part
+Congratulation, now you got the source code in a subdirectory called ''adonthell''. The tricky part begins.
-begins.
 === Compilation ===
 assuming you are in
-''/home/enrico/vanilla_adonthell''<br>
+''/home/enrico/vanilla_adonthell''
-$ mkdir adonthell-build && cd adonthell-build<br>
-$ cmake -DCMAKE_INSTALL_PREFIX=/usr/local ../adonthell<br>
-$ make<br>
+ $ mkdir adonthell-build && cd adonthell-build
+ $ cmake -DCMAKE_INSTALL_PREFIX=/usr/local ../adonthell
+ $ make
-(details at
+{| border=1 cellspacing=0 cellpadding=5 align=center width=100%
-http://adonthell.berlios.de/doc/index.php/Development:Compiling)
+|- 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 ===
 make sure you are in
-''/home/enrico/vanilla_adonthell/adonthell-build''<br>
+''/home/enrico/vanilla_adonthell/adonthell-build''
-$ sudo make install<br>
+ $ sudo make install
-or as superuser<br>
+or as superuser
-$# make install
+ $# make install
 === Test ===
 make sure you are in
-''/home/enrico/vanilla_adonthell/adonthell-build''<br>
+''/home/enrico/vanilla_adonthell/adonthell-build''
-$ test/worldtest -g ../adonthell/test/<br>
+ $ test/worldtest -g ../adonthell/test/ data
 the previous command should present a small demo
-=== doc ===
+=== Troubleshooting ===
-has to be created
+Workarounds for known problems during the build and when running Adonthell are listed [[Development:Compiling#Fixing_problems|here]].
-change dir to ''../adonthell/doc/'' and execute<br>
-$ doxygen reference.cfg<br>
+=== Doc ===
+To create the source code documentation, you will need [http://www.doxygen.org/ doxygen] and dot, which is part of the [http://www.graphviz.org/ graphviz] package.
+Change directory 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 [http://adonthell.berlios.de/api/ online]. It is usually updated after larger changes to the code have taken place.