diff --git a/README b/README index b8e28b5..8d75952 100644 --- a/README +++ b/README @@ -1,7 +1,53 @@ -C++ Library for automated C-Library resource management, UNIX Pipes, -simple and secure UNIX system command execution, runtime stack trace, -automated unexpected exception handling and enhancements to the C++ -STL and string libraries. +Featureful C++ Library containing a lot of needful things. Everything, +I often need, but it's missing in C++ standard libraries and other +common 3rd party libraries, such as log4cxx, cppunit and boost. + +I have paid attention to define simple and a nice to use +interfaces. The library makes use of object orientation, operator +overload and templates, where it makes sense. The library passes +several module tests before each delivery. It is therefore stable and +tested. + +The library contains modules for the following purposes: + + - Collect and Format a Stack Trace + Having a stack trace is extremely useful, if you have + unexpected or uncaught exceptions + - Exceptions with Stack Trace + - Automated Unexpected and Terminate Handler + + - C++ Evaluation of Command Line Arguments + A fully object oriented replacement for optarg + + - Classes for Automated Resource Handling + Automatically free resources from C libraries, + such as open, malloc, etc. + + - Configuration File Handler + Read and write UNIX / Windows like configuration files + + - Execute UNIX Commands + Write to stdin and read from stdout, stderr of the sub process + + - File and System Utilities + C++ wrapper around C library file and directory access (incomplete) + + - Regular Expressions + C++ wrapper around C library regular expressions + + - Tokenizer + Split a string into tokens and iterate through them + + - Simple Tracing (for temporary debugging) + + - Extensions for C++ Standard Libraries + + - STL extensions + - Shift values into containers + - Read Line that reads a full line + + - String extensions + Add integers to strings, shift into strings HTML and PDF documentation is include in the installation (built with -Doxygen) and available online on: http://marc.waeckerlin.org/mrw-c++ \ No newline at end of file +Doxygen) and available online on: http://marc.waeckerlin.org/mrw-c++