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

= PACPUS framework =

== Compilation ==

=== Prerequisites ===

==== Tools ====
* Modern C++ compiler (gcc >= 4.5, clang >= 3.2, Microsoft Visual Studio 2008 or newer, etc.)
* [http://www.cmake.org/ CMake] 2.8.10 or newer
* [http://www.doxygen.org/ Doxygen] (optionally)
* [http://subversion.apache.org/ Subversion (SVN)] control version system

==== Libraries ====
* [http://logging.apache.org/log4cxx/ Apache log4cxx] 0.10.0
* [http://www.boost.org/ Boost] 1.50 or newer (optionally)
* [http://qt-project.org/ Qt] 4.8 or newer

=== Getting the source code ===
To checkout !PacpusFramework repository (version 0.1.1) into your workspace directory, e.g. into `~/workspace/pacpus`, 

{{{#!sh
cd ~/workspace/pacpus
svn co https://devel.hds.utc.fr/svn/pacpusframework/tags/0.1.1/ pacpusframework
}}}

**Note:** You can as well use any GUI wrapper for SVN, such as [http://tortoisesvn.net/ TortoiseSVN].

=== Using CMake ===

==== GUI ====
You have to point the source code directory with the root `CMakeLists.txt` file, e.g. `~/workspace/pacpus/framework`
and the build directory, e.g. `~/workspace/pacpus/framework-build`.
Then press `Configure` and `Generate`.
You can change the CMake variables as well.

==== Command-line ====

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

{{{#!sh
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.

=== Compiling ===
If you have created Makefile files, than just run the command:
{{{#!sh
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.:
{{{#!sh
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 

Once you have successfully compiled Pacpus Framework, you can install it using:
{{{#!sh
make install
}}}
or, if you use a GUI-based development environment, you have to build the `INSTALL` target/project.

----
== Getting started ==

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

----
== Documentation == 

PACPUS API

----
== Active tickets ==
[[TicketQuery(max=10,status=new|assigned|reopened,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]



----

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]