[[PageOutline(1-10,Contents,inline)]]

= PACPUS framework =

== Compilation ==

=== Prerequisites ===

==== Tools ====
* CMake 2.8.10 or newer
* Doxygen (optionally)

==== Libraries ====
* Apache log4cxx 0.10.0
* Boost 1.50 or newer (optionally)
* Qt 4.8 or newer

=== Using CMake ===

Checkout Pacpus framework repository into your workspace directory, e.g. into ```~/workspace/pacpus```.

{{{
cd ~/workspace/pacpus
svn co https://devel.hds.utc.fr/svn/pacpusframework/trunk framework
}}}

Without changing directory (stay in ```D:\workspace\pacpus```), create a new directory for build, change the directory to the newly created one and execute CMake.

{{{
cd ~/workspace/pacpus
mkdir framework-build
cd framework-build
cmake ../framework -G "Unix Makefiles"
}}}

**Note:** You can specify a different makefile generator instead of ```-G "Unix Makefiles"```.
Type ```cmake --help``` for a list of generators available on your platform.

If you have created Makefile files, than just run the command:
{{{
make
}}}
or a similar one (nmake, mingw32-make, etc.).

If you have created project files (for example using option ```-G Visual Studio 11``), than just open the solution file **Pacpus.(extension)**, e.g.:
{{{
Pacpus.sln
}}}

== Installation == 

The PACPUS framework is available on several OS: Linux, Windows and Mac OS X. 

- Installation guide of PACPUS on Windows : TO COME
- Installation guide of PACPUS on Linux Ubuntu : TO COME
- Installation guide of PACPUS on Mac OS X : TO COME
- Installation guide of PACPUS on Linux embedded : TO COME 

== Getting started ==

The tutorials are under development, they will be published soon. 

== Documentation == 

PACPUS API

NB: If you need more informations about the TRAC system used to manage this collaborative site, you can read this [TracDefaultWelcomePage page] or view the official [http://trac.edgewall.org/ TRAC project]