Muldersoft/MUtilities
Muldersoft/MUtilities
1
0
Fork 0
Code Releases Activity
53830e0b96
MUtilities/README.html

126 lines
8.9 KiB
HTML
Raw Normal View History

Updated README file.
2016-04-16 14:25:52 +02:00
<!DOCTYPE html>
Initial commit.
2014-11-21 17:11:57 +01:00
<html>
<head>
Updated README file.
2016-04-16 14:25:52 +02:00
<meta charset="utf-8">
<meta name="generator" content="pandoc">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
<meta name="author" content="Created by LoRd_MuldeR &lt;mulder2@gmx&gt; – check http://muldersoft.com/ for news and updates!">
<title>MUtilities – README</title>
<style type="text/css">code{white-space: pre;}</style>
<!--[if lt IE 9]>
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
<![endif]-->
<style type="text/css">
<!--
body { font-family: "Times New Roman", Times, serif; color: #000000; background-color: #FFFFFF; }
p { text-align: justify; }
tt, pre, code { font-family: Courier New, Courier, mono; background-color: #EDF3F7; padding: 1px; }
h1:not(.title) { margin-top: 2.25em; }
h2:not(.author) { margin-top: 2.0em; }
h3, h4 { margin-top: 1.75em; }
a { color: #0000BB; text-decoration: none; }
a:visited { color: #0000BB; text-decoration: none; }
a:active { color: #0000FF; text-decoration: none; }
a:hover { color: #0000FF; text-decoration: underline; }
img { margin-bottom: 0.75em; }
ul, ol { margin-bottom: 2.0em; }
li>ul, li>ol { margin-bottom: 0em; }
-->
</style>
Initial commit.
2014-11-21 17:11:57 +01:00
</head>
<body>
Updated README file.
2016-04-16 14:25:52 +02:00
<header>
<h1 class="title">MUtilities – README</h1>
<h2 class="author">Created by LoRd_MuldeR &lt;<script type="text/javascript">
<!--
h='&#x67;&#x6d;&#120;';a='&#64;';n='&#x6d;&#x75;&#108;&#100;&#x65;&#114;&#50;';e=n+a+h;
document.write('<a h'+'ref'+'="ma'+'ilto'+':'+e+'" clas'+'s="em' + 'ail">'+e+'<\/'+'a'+'>');
// -->
</script><noscript>&#x6d;&#x75;&#108;&#100;&#x65;&#114;&#50;&#32;&#x61;&#116;&#32;&#x67;&#x6d;&#120;</noscript>&gt; – check <a href="http://muldersoft.com/" class="uri">http://muldersoft.com/</a> for news and updates!</h2>
</header>
<nav id="TOC">
<ul>
<li><a href="#introduction"><span class="toc-section-number">1</span> Introduction</a></li>
Documentation updates.
2016-12-19 02:43:38 +01:00
<li><a href="#project-structure"><span class="toc-section-number">2</span> Project Structure</a></li>
Some documentation updates.
2016-12-19 17:09:58 +01:00
<li><a href="#example"><span class="toc-section-number">3</span> Example</a><ul>
<li><a href="#build-notes"><span class="toc-section-number">3.1</span> Build Notes</a></li>
</ul></li>
<li><a href="#api-documentation"><span class="toc-section-number">4</span> API Documentation</a></li>
<li><a href="#license"><span class="toc-section-number">5</span> License</a></li>
<li><a href="#acknowledgement"><span class="toc-section-number">6</span> Acknowledgement</a></li>
Updated README file.
2016-04-16 14:25:52 +02:00
</ul>
</nav>
<h1 id="introduction"><span class="header-section-number">1</span> Introduction</h1>
Updated README file.
2016-04-16 14:28:32 +02:00
<p>The <strong>MUtilities</strong> library is a collection of routines and classes to extend the <a href="http://qt-project.org/"><em>Qt cross-platform framework</em></a>. It contains various convenience and utility functions as well as wrappers for OS-specific functionalities. The library was originally created as a &quot;side product&quot; of the <a href="http://lamexp.sourceforge.net/"><strong>LameXP</strong></a> application: Over the years, a lot of code, <strong>not</strong> really specific to <em>LameXP</em>, had accumulated in the <em>LameXP</em> code base. Some of that code even had been used in other projects too, in a &quot;copy &amp; paste&quot; 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 <strong>MUtilities</strong> (aka &quot;MuldeR's Utilities for Qt&quot;) library. This library now forms the foundation of <em>LameXP</em> and <a href="https://github.com/lordmulder"><em>other OpenSource projects</em></a>.</p>
Documentation updates.
2016-12-19 02:43:38 +01:00
<h1 id="project-structure"><span class="header-section-number">2</span> Project Structure</h1>
Some documentation updates.
2016-12-19 17:09:58 +01:00
<p>The <em>MUtilities</em> project directory is organized as follows:</p>
Documentation updates.
2016-12-19 02:43:38 +01:00
<ul>
<li><code>bin/</code> – compiled library files (static or shared), link those files in projects that use the MUtilities library</li>
<li><code>docs/</code> – programming interface documentation, generated with Doxygen tool</li>
<li><code>etc/</code> – miscellaneous files, everything that doesn't fit in anywhere else</li>
<li><code>include/</code> – public header files, include this directory in projects that use the MUtilities library</li>
<li><code>obj/</code> – object code files, intermediate files generated during the build process</li>
<li><code>res/</code> – resouce files, required for building the MUtilities library</li>
<li><code>src/</code> – source code files, required for building the MUtilities library (third-party code in <code>src/3rd_party/</code>)</li>
<li><code>test/</code> – unit tests, based on Google Test framework</li>
<li><code>tmp/</code> – temporary files, automatically generated during the build process</li>
</ul>
Some documentation updates.
2016-12-19 17:09:58 +01:00
<h1 id="example"><span class="header-section-number">3</span> Example</h1>
<p>Here is a minimal example on how to use the <em>MUtilities</em> library in your project:</p>
<pre><code>//MUtils
#include &lt;MUtils/Global.h&gt;
int main(int argc, char **argv)
{
qDebug(&quot;Random number: %u\n&quot;, MUtils::next_rand_u32());
}</code></pre>
<h2 id="build-notes"><span class="header-section-number">3.1</span> Build Notes</h2>
<ul>
<li>In order to use the <em>MUtilities</em> library in your project, your build environment must have already been set up for building Qt-based projects. Setting up Qt is <em>not</em> covered by this document.</li>
<li>Additionally, make sure that <em>MUtilities'</em> <code>include/</code> directory is contained in your &quot;Additional Include Directories&quot; and that the <em>MUtilities'</em> <code>bin/</code> directory is contained in your &quot;Additional Library Directories&quot;.</li>
<li>Finally, make sure that your project links against the <code>MUtils32-1.lib</code> library file. For each build configuration you have to pick the proper <strong>.lib</strong> file from the correspnding <code>bin/&lt;platform&gt;/&lt;config&gt;/</code> directory!</li>
<li>If your projects intends to use the <em>MUtilities</em> library as a <strong>static</strong> library, then the macro <code>MUTILS_STATIC_LIB</code> <em>must</em> be added to your project's &quot;Preprocessor Definitions&quot;.</li>
</ul>
<h1 id="api-documentation"><span class="header-section-number">4</span> API Documentation</h1>
Documentation updates.
2016-12-19 02:43:38 +01:00
<p>A fully-fledged documentation of the <em>MUtilities</em> programming interface (API) is available thanks to <a href="http://www.stack.nl/~dimitri/doxygen/"><em>Doxygen</em></a>. Please see <a href="docs/index.html"><strong><code>docs/index.html</code></strong></a> for details!</p>
Some documentation updates.
2016-12-19 17:09:58 +01:00
<h1 id="license"><span class="header-section-number">5</span> License</h1>
Updated README file.
2016-04-16 14:28:32 +02:00
<p>This library is free software. It is released under the terms of the <a href="https://www.gnu.org/licenses/lgpl-2.1.html"><em>GNU Lesser General Public License (LGPL), Version 2.1</em></a>.</p>
Updated README file.
2016-04-16 14:25:52 +02:00
<pre><code>MUtilities - MuldeR&#39;s Utilities for Qt
Copyright (C) 2004-2016 LoRd_MuldeR &lt;MuldeR2@GMX.de&gt;. 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.</code></pre>
Some documentation updates.
2016-12-19 17:09:58 +01:00
<h1 id="acknowledgement"><span class="header-section-number">6</span> Acknowledgement</h1>
Updated README file.
2016-04-16 14:25:52 +02:00
<p>The following third-party code is used in the MUtilities library:</p>
<ul>
<li><p><strong>Keccak/SHA-3 Reference Implementation</strong><br />
Implementation by the Keccak, Keyak and Ketje Teams, namely, Guido Bertoni, Joan Daemen, Michaël Peeters, Gilles Van Assche and Ronny Van Keer<br />
No Copyright / Dedicated to the Public Domain</p></li>
<li><p><strong>Natural Order String Comparison</strong><br />
Copyright (C) 2000, 2004 by Martin Pool <script type="text/javascript">
<!--
h='&#x73;&#x6f;&#x75;&#114;&#x63;&#x65;&#102;&#114;&#x6f;&#x67;&#46;&#110;&#x65;&#116;';a='&#64;';n='&#x6d;&#98;&#112;';e=n+a+h;
document.write('<a h'+'ref'+'="ma'+'ilto'+':'+e+'" clas'+'s="em' + 'ail">'+e+'<\/'+'a'+'>');
// -->
</script><noscript>&#x6d;&#98;&#112;&#32;&#x61;&#116;&#32;&#x73;&#x6f;&#x75;&#114;&#x63;&#x65;&#102;&#114;&#x6f;&#x67;&#32;&#100;&#x6f;&#116;&#32;&#110;&#x65;&#116;</noscript><br />
Released under the zlib License</p></li>
<li><p><strong>Adler-32 Checksum Algorithm (from zlib)</strong><br />
Copyright (C) 1995-2013 Jean-loup Gailly and Mark Adler<br />
Released under the zlib License</p></li>
</ul>
<p> </p>
<p><strong>e.o.f.</strong></p>
Initial commit.
2014-11-21 17:11:57 +01:00
</body>
</html>
Copy Permalink