README.md

   1 % MUtilities &ndash; README
   2 % Created by LoRd_MuldeR &lt;<mulder2@gmx>&gt; &ndash; check <http://muldersoft.com/> for news and updates!
   3
   4 # Introduction #
   5
   6 The **MUtilities** library is a collection of routines and classes to extend the [*Qt cross-platform framework*](http://qt-project.org/). It contains various convenience and utility functions as well as wrappers for OS-specific functionalities. The library was originally created as a "side product" of the [**LameXP**](http://lamexp.sourceforge.net/) application: Over the years, a lot of code, **not** really specific to *LameXP*, had accumulated in the *LameXP* code base. Some of that code even had been used in other projects too, in a "copy & paste" fashion &ndash; which had lead to redundancy and much complicated maintenance. In order to clean-up the LameXP code base, to eliminate the ugly redundancy and to simplify maintenance, the code in question has finally been refactored into the **MUtilities** (aka "MuldeR's Utilities for Qt") library. This library now forms the foundation of *LameXP* and [*other OpenSource projects*](https://github.com/lordmulder).
   7
   8
   9 # Project Structure
  10
  11 The *MUtilities* project directory is structured as follows:
  12
  13 * `bin/` &ndash; compiled library files (static or shared), link those files in projects that use the MUtilities library
  14 * `docs/` &ndash; programming interface documentation, generated with Doxygen tool
  15 * `etc/` &ndash; miscellaneous files, everything that doesn't fit in anywhere else
  16 * `include/` &ndash; public header files, include this directory in projects that use the MUtilities library
  17 * `obj/` &ndash; object code files, intermediate files generated during the build process
  18 * `res/` &ndash; resouce files, required for building the MUtilities library
  19 * `src/` &ndash; source code files, required for building the MUtilities library (third-party code in `src/3rd_party/`)
  20 * `test/` &ndash; unit tests, based on Google Test framework
  21 * `tmp/` &ndash; temporary files, automatically generated during the build process
  22
  23
  24 # API Documentation
  25
  26 A fully-fledged documentation of the *MUtilities* programming interface (API) is available thanks to [*Doxygen*](http://www.stack.nl/~dimitri/doxygen/). Please see [**`docs/index.html`**](docs/index.html) for details!
  27
  28
  29 # License
  30
  31 This library is free software. It is released under the terms of the [*GNU Lesser General Public License (LGPL), Version 2.1*](https://www.gnu.org/licenses/lgpl-2.1.html).
  32
  33     MUtilities - MuldeR's Utilities for Qt
  34     Copyright (C) 2004-2016 LoRd_MuldeR <MuldeR2@GMX.de>. Some rights reserved.
  35
  36     This library is free software; you can redistribute it and/or
  37     modify it under the terms of the GNU Lesser General Public
  38     License as published by the Free Software Foundation; either
  39     version 2.1 of the License, or (at your option) any later version.
  40
  41     This library is distributed in the hope that it will be useful,
  42     but WITHOUT ANY WARRANTY; without even the implied warranty of
  43     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  44     Lesser General Public License for more details.
  45
  46     You should have received a copy of the GNU Lesser General Public
  47     License along with this library; if not, write to the Free Software
  48     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.
  49
  50
  51 # Acknowledgement
  52
  53 The following third-party code is used in the MUtilities library:
  54
  55 * **Keccak/SHA-3 Reference Implementation**
  56   Implementation by the Keccak, Keyak and Ketje Teams, namely, Guido Bertoni, Joan Daemen, Michaël Peeters, Gilles Van Assche and Ronny Van Keer
  57   No Copyright / Dedicated to the Public Domain
  58
  59 * **Natural Order String Comparison**
  60   Copyright (C) 2000, 2004 by Martin Pool <mbp@sourcefrog.net>
  61   Released under the zlib License
  62
  63 * **Adler-32 Checksum Algorithm (from zlib)**
  64   Copyright (C) 1995-2013 Jean-loup Gailly and Mark Adler
  65   Released under the zlib License
  66
  67 &nbsp;
  68
  69 **e.o.f.**