MUtilities – README

Created by LoRd_MuldeR <> – check http://muldersoft.com/ for news and updates!

1 Introduction

The MUtilities library is a collection of routines and classes to extend the Qt cross-platform framework. 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 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 – 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.

2 Project Structure

The MUtilities project directory is organized as follows:

3 Example

Here is a minimal example on how to use the MUtilities library in your project:

//MUtils
#include <MUtils/Global.h>

int main(int argc, char **argv)
{
    qDebug("Random number: %u\n", MUtils::next_rand_u32());
}

3.1 Build Notes

4 API Documentation

A fully-fledged documentation of the MUtilities programming interface (API) is available thanks to Doxygen. Please see docs/index.html for details!

5 License

This library is free software. It is released under the terms of the GNU Lesser General Public License (LGPL), Version 2.1.

MUtilities - MuldeR's Utilities for Qt
Copyright (C) 2004-2017 LoRd_MuldeR <MuldeR2@GMX.de>. Some rights reserved.

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

This library 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
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.

6 Acknowledgement

The following people have contributed in the development of the MUtilities library:

The following third-party code is used in the MUtilities library:

 

e.o.f.