Read Me

This file is part of libmoep.

Copyright (C) 2008 Martin Schlosser
email: neotrantor@users.sourceforge.net
www:   http://sourceforge.net/projects/libmoep


This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program in a file named COPYING.
If not, see <http://www.gnu.org/licenses/>.


Description:
----------------------------------------
libmoep is basically a library containing a collection of useful
functions, classes etc. Many of them may already exist in other libraries
and i'm sure among those there are more mature libraries with better
implementations, documentation and support. However, I wrote libmoep
for educational purposes and because I wanted a "light weight" solution
that just fits the needs for my software projects.
In most cases I use the namespace "libmoep" to prevent naming conflicts
and make it easier to find things. There is no documentation for now
so just try to read the code in case you find something interesting.
I'm trying to write clear and self-explanatory code and with some luck
you can find a comments here and there.


Dependencies / requirements:
----------------------------------------
 - cmake or Visual Studio for building the library
 - bzip2 / libbz2


What libmoep contains to date (May 2008)
----------------------------------------
 - XML parsing / generating functions (probably the only useful thing in the library ;))
 - command line argument parser
 - (de)compression functions (currently only BZ2)
 - a helper function for M$ Windows file context menus
 - file tools / helper functions
 - file tree class
 - string tools
 - serial communication functions (just started, not very clean and useful)
 - minimal 3D vector class (don't laugh at it ;))
more to come...