added index.doc
[libt2n] / doc / index.doc
1// mainpage should not be here
3/*! \mainpage libt2n - (talk to neighbor)
4 \section intro_sec Introduction
5 libt2n (talk to neighbor) is a C++ library for inter-process communication (IPC, s.a.
6 with an additional code generator to make remote procedure calls simple.
7 \par
8 XXX: improve this paragraph: The input for the code generator is standard C++ code (in fact we use gccxml to parse the C++ code and the code generator takes the XML as input) and you mark the procedures you want to expose to other processes.
9 It then generates the stubs needed.
10 The exported procedures can be grouped. For each group the code generator is called and generates 6 output files: group_common.hxx, group_common.cpp, group_client.hxx, group_client.cpp, group_server.hxx, group_server.cpp. The _common files are used by client and server whereas the _client files are used by the client and the _server files by the server only.
11 \par
12 To simplify the build process a Makefile snippet is provided that allows to create a server program and a client library (including a corresponding .pc file) using the autotools easily.
13 \section install_sec Installation
15 \subsection requirements Requirements
16 - boost <> (serialization <>)
17 - gccxml <>
18 - libxmlpp <>
20 \subsection recommended Recommended
21 - pkg-config <>
22 - autotools (automake, autoconf, libtool)
24 \subsection Compilation
25 \verbatim
26 ./configure && make install
27 \endverbatim
29 \subsection Usage
30 \sa file:../../../libt2n-examples/doc/html/index.html