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 organized 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; resource 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 # Example
  25
  26 Here is a minimal example on how to use the *MUtilities* library in your project:
  27
  28     //MUtils
  29     #include <MUtils/Global.h>
  30
  31     int main(int argc, char **argv)
  32     {
  33         qDebug("Random number: %u\n", MUtils::next_rand_u32());
  34     }
  35
  36 ## Build Notes
  37
  38 * In order to use the *MUtilities* library in your project, your build environment must have already been set up for building Qt-based projects. Setting up Qt is *not* covered by this document.
  39 * Additionally, make sure that *MUtilities'* `include/` directory is contained in your "Additional Include Directories" and that the *MUtilities'* `bin/` directory is contained in your "Additional Library Directories".
  40 * Finally, make sure that your project links against the `MUtils32-1.lib` library file. For each build configuration, pick the proper **.lib** file from the corresponding `bin/<platform>/<config>/` directory!
  41 * If your projects intends to use the *MUtilities* library as a **static** library, then the macro `MUTILS_STATIC_LIB` *must* be added to your project's "Preprocessor Definitions".
  42
  43
  44 # API Documentation
  45
  46 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!
  47
  48
  49 # License
  50
  51 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).
  52
  53     MUtilities - MuldeR's Utilities for Qt
  54     Copyright (C) 2004-2019 LoRd_MuldeR <MuldeR2@GMX.de>. Some rights reserved.
  55
  56     This library is free software; you can redistribute it and/or
  57     modify it under the terms of the GNU Lesser General Public
  58     License as published by the Free Software Foundation; either
  59     version 2.1 of the License, or (at your option) any later version.
  60
  61     This library is distributed in the hope that it will be useful,
  62     but WITHOUT ANY WARRANTY; without even the implied warranty of
  63     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  64     Lesser General Public License for more details.
  65
  66     You should have received a copy of the GNU Lesser General Public
  67     License along with this library; if not, write to the Free Software
  68     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.
  69
  70
  71 # Acknowledgement
  72
  73 The following people have contributed in the development of the MUtilities library:
  74
  75 * **John Buonagurio &lt;<jbuonagurio@exponent.com>&gt;**
  76   Support for Qt5
  77
  78 The following third-party code is used in the MUtilities library:
  79
  80 * **Keccak/SHA-3 Reference Implementation**
  81   Implementation by the Keccak, Keyak and Ketje Teams, namely, Guido Bertoni, Joan Daemen, Michaël Peeters, Gilles Van Assche and Ronny Van Keer
  82   No Copyright / Dedicated to the Public Domain
  83
  84 * **Natural Order String Comparison**
  85   Copyright (C) 2000, 2004 by Martin Pool &lt;<mbp@sourcefrog.net>&gt;
  86   Released under the zlib License
  87
  88 * **Adler-32 Checksum Algorithm (from zlib)**
  89   Copyright (C) 1995-2013 Jean-loup Gailly and Mark Adler
  90   Released under the zlib License
  91
  92 &nbsp;
  93
  94 **e.o.f.**