Howtos¶

Hack on Windows Seven¶

You need to :

1. Install Tortoise Git : http://code.google.com/p/tortoisegit/.
   1. Kind of SSH Client : TortoisePLink
2. Install msysgit (needed by Tortoise Git) : http://code.google.com/p/msysgit/.
   1. Use Unix style end line.
   2. Do not install in "Program files" or in a path which contains spaces. We recommend to install in C:\git.
3. If you want an access to the master repository : generate a RSA 2048 bit with Puttygen (come with tortoisegit) and send it to a project manager.
4. Install Qt SDK (Qt creator is included) : http://get.qt.nokia.com/qtsdk/qt-sdk-win-opensource-2010.02.1.exe .
   1. Copy and rename C:\Qt\2010.02.1\mingw\bin\mingw32-make to make (needed by protocol buffer).
5. Add C:\Qt\2010.02.1\mingw\bin;C:\Qt\2010.02.1\qt\bin to your path environment variable.
6. Install proto buff library source
   1. Download the source zip here : http://code.google.com/p/protobuf/downloads/list and unzip in C:\protobuf
   2. Correct the file subprocess.h as described here : http://code.google.com/p/protobuf/issues/detail?id=155
   3. Launch "Git bash" and go to /c/protobuf then type :
      1. ./configure
      2. make
   4. Add to your path this directory : C:\protobuf\src to reach executable protoc.
   5. For each component which uses protobuf, you have to define a Build Environment Variable PROTOBUF set to C:\protobuf
7. Git clone the repository :
   1. git://dev.aybabtu.org/aybabtu.git if you just want clone the repository.
   2. ssh://git@dev.aybabtu.org/aybabtu.git if you have a full access (read+write).
8. Generate the sources for the .proto files
   1. Launch "Git bash" and go to aybabtu/application
   2. Type ./1.generate_proto_cpp.sh (each time you modify the .proto files you have to run this script)
9. Set up Qt Creator
   1. TODO

Hack on Linux¶

ArchLinux¶

You need to :

1. Install required programs
   1. Git : pacman -S git
   2. protobuf : pacman -S protobuf
   3. Qt creator : pacman -S qtcreator
2. Git clone the repository
   1. git://dev.aybabtu.org/aybabtu.git if you just want clone the repository.
   2. ssh://git@dev.aybabtu.org/aybabtu.git if you have a full access (read+write).

Ubuntu¶

1. Get required tools

   sudo apt-get install qtcreator g++ git
   cd /tmp
   wget http://protobuf.googlecode.com/files/protobuf-2.3.0.tar.bz2
   tar -jxvf ./protobuf-2.3.0.tar.bz2
   cd protobuf-2.3.0
   ./configure --prefix=/usr
   make
   make check
   sudo make install
   

2. Get source code

   git clone git://dev.euphorik.ch/aybabtu.git aybabtu
   cd aybabtu/application
   ./1.generate_protos_cpp.sh
   

Generate the documentation¶

The code documentation is generated with Doxygen. You must also install Graphviz to enable the diagram generation.

A daily generated documentation can be found here : http://doc.aybabtu.org (errors).

To locally build the documentation you just have to install Doxygen and Graphviz. The configuration file is located here : source:/doc/doxygen/Doxyfile it can be opened by the graphic utility Doxywizard or by the command line doygen Doxyfile. The documentation will be generated in /doc/doxygen/html.