File Layout:
------------

|~examples/
| |+Buffer/ Sample implementation of std::streambuf;
| |+rot13/  Sample module (http://en.wikipedia.org/wiki/Rot13);
|+include/  API Interfaces Headers;
|+uml/      API Diagrams.

Build examples:
-------------------

You will need cmake >= 2.4 and a compiler tool-chain.

You can install cmake with your OS tools or get it from the cmake website at:
http://www.cmake.org/cmake/resources/software.html

Launch cmake-gui and follow instructions on the screen. You can choose to
create a Makefile or a VisualStudio solution or any other choice at your
convenience.

If you don't have the cmake-gui (older version of cmake for Unix for example)
use this command:

cd /where/you/have/extracted/the/sources/ && cmake . && make

Install the api headers on your system:
---------------------------------------

This is optional.

Windows: Use the installer, then adjust your environ to add a variable which
point to the include dir and use this variable in VS.

If you are not on Windows do as in "Build examples" but after make do:

make install

Uninstall the api headers from your system:
-------------------------------------------

Windows: Use the uninstaller.

If you are not on Windows do as in "Build examples" but after make do:

make uninstall

FAQ:
----

How do I change the install prefix ?
 * Use cmake-gui and change the variable CMAKE_INSTALL_PREFIX;
 * OR reconfigure the project with cmake -DCMAKE_INSTALL_PREFIX=/install/prefix/ .