Read Me

C Program Foundation Library
    
    Suite of libraries meant to properly start any new project.
    Includes:
    
    Shared Memory Library
    
    Library intended to ease the communication task between the processes.
    The main idea is that a user can create one or more shared memory
    areas where the programs exchange data. They can be aware of data
    changes by making pools in a while loop. Every access to the shared
    zone is conditioned by acquiring a semaphore lock. Data in the 
    memories can be easily saved to a file. Each method is thread safe
    so concurrency related problems are solved by the library.
    
    Program Base Library - lists, heaps, sets and more
    
    This project internally uses the "PBL - The Program Base Library",
    created by Peter Graf. This library is also compiled and exported for future 
    linking to other programs. Thank you Peter for creating this library!
    
    Logger
    
    Easy to use logging facilities.
    
    http://www.mission-base.com/peter/source/
    
    Copyright (C) 2012  Andrei Ivan <antraxx_cs@yahoo.com>

-- Compile requirements

--- build-essentials package (required)
--- CMake build system (required)
--- Doxygen code documentation (required only for the doc target)
--- CUnit for generating the test program (not required)

-- How to compile

--- Compile project
--- $ mkdir build; cd build
--- $ cmake ..
--- $ make 
--- # make install # install to the system the libpbl and libsharedmem libraries

-- Cross compile
--- cmake -D CMAKE_TOOLCHAIN_FILE=crosscompile.cmake -D CMAKE_INSTALL_PREFIX=<path_to_install> ..
--- or use the toolchain approach cmake -D CMAKE_TOOLCHAIN_FILE=crosscompile.cmake
---- Check the sample toolchain file for an overview of what's to be set there

-- Other useful cmake variables
--- CMAKE_INSTALL_PREFIX = directory where to install
--- CMAKE_FIND_ROOT_PATH = the root where to search for all the libraries and includes
--- BUILD_SHARED_LIBS = set this to "ON" if you want to build shared libs instead
--- CMAKE_BUILD_TYPE = this can be set to DEBUG if you want to debug this lib
--- CMAKE_TOOLCHAIN_FILE = specify a toolchain file for ease of cross compiling

-- The project has a cmake find module at cmake/modules that can be used for finding the
-- lib in other projects

Versions:

17-02-2013 <1.0.0> : First release on Sourceforge