# Copyright (C)  2006  Daniele Zelante

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2
or any later version published by the Free Software Foundation.

@LICENSE
@$Id: README,v 1.2 2006/01/02 22:06:46 zeldan Exp $

COMF is free software.  See the file COPYING for copying conditions.

COMF is a C++ Object and Memory Framework

It is a library for C++ on GNU/Linux, FreeBSD, NetBSD, Cygwin


This library provides classes for memory management, wrapping memory allocation and deallocation in constructors and destructors.
It provides classes to memory-map files, manage exceptions and other basilar functionalities (i.e. noncopiable objects, simple string operations).
This library provides classes for object serialization, in binary and text format.
Common makefiles are available in order to use easily this library in other libraries or programs.

Here I list the main files/parts of COMF:
bstorage  : binary serialization
comf      : main files
defs      : macros for user (prefixed by COMF_ to avoid conflicts)
exception : exception classes (base exceptions, and warpping errno)
file      : file classes (file, locks, file mappings)
globals   : generic global functions
integer   : integer functions (gcd lcm and similar)
memory    : memory management, memory areas and allocation
mystd     : functions to extend and/or serialize Standard C++ collections
object    : base object classes (serializable, non-copiable)
socket    : TCP socket wrapper
soinfo    : info about shared object use chain (not using ELF data) 
string    : string parsing, number conversion
test      : classes to easily implement tests
text      : log files and generic i/o to text files
tstorage  : text serialiation
types     : typdefs and similar


This project can also be used by Eclipse when extracted using CVS.

This module (comf) depends on 'makroz' in the same project,
so you have to install makroz before building comf.
To build comf just type as usually:
./configure
make
make install

Youd may set PREFIX environment variable to specify installation directory.


Please send all bug reports by electronic mail to: <zeldan@email.it>
