Some improvements to clean_file_path() function.
[MUtilities.git] / README.html
blob94c70723549c589bb50e2f2165b4eaf18dfc2af4
1 <!DOCTYPE html>
2 <html>
3 <head>
4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <meta name="author" content="Created by LoRd_MuldeR &lt;mulder2@gmx&gt; – check http://muldersoft.com/ for news and updates!">
8 <title>MUtilities – README</title>
9 <style type="text/css">code{white-space: pre;}</style>
10 <!--[if lt IE 9]>
11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
12 <![endif]-->
13 <style type="text/css">
14 <!--
15 body { font-family: "Times New Roman", Times, serif; color: #000000; background-color: #FFFFFF; }
16 p { text-align: justify; }
17 tt, pre, code { font-family: Courier New, Courier, mono; background-color: #EDF3F7; padding: 1px; }
18 h1:not(.title) { margin-top: 2.25em; }
19 h2:not(.author) { margin-top: 2.0em; }
20 h3, h4 { margin-top: 1.75em; }
21 a { color: #0000BB; text-decoration: none; }
22 a:visited { color: #0000BB; text-decoration: none; }
23 a:active { color: #0000FF; text-decoration: none; }
24 a:hover { color: #0000FF; text-decoration: underline; }
25 img { margin-bottom: 0.75em; }
26 ul, ol { margin-bottom: 2.0em; }
27 li>ul, li>ol { margin-bottom: 0em; }
28 -->
29 </style>
30 </head>
31 <body>
32 <header>
33 <h1 class="title">MUtilities – README</h1>
34 <h2 class="author">Created by LoRd_MuldeR &lt;<script type="text/javascript">
35 <!--
36 h='&#x67;&#x6d;&#120;';a='&#64;';n='&#x6d;&#x75;&#108;&#100;&#x65;&#114;&#50;';e=n+a+h;
37 document.write('<a h'+'ref'+'="ma'+'ilto'+':'+e+'" clas'+'s="em' + 'ail">'+e+'<\/'+'a'+'>');
38 // -->
39 </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>
40 </header>
41 <nav id="TOC">
42 <ul>
43 <li><a href="#introduction"><span class="toc-section-number">1</span> Introduction</a></li>
44 <li><a href="#license"><span class="toc-section-number">2</span> License</a></li>
45 <li><a href="#acknowledgement"><span class="toc-section-number">3</span> Acknowledgement</a></li>
46 </ul>
47 </nav>
48 <h1 id="introduction"><span class="header-section-number">1</span> Introduction</h1>
49 <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>
50 <h1 id="license"><span class="header-section-number">2</span> License</h1>
51 <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>
52 <pre><code>MUtilities - MuldeR&#39;s Utilities for Qt
53 Copyright (C) 2004-2016 LoRd_MuldeR &lt;MuldeR2@GMX.de&gt;. Some rights reserved.
55 This library is free software; you can redistribute it and/or
56 modify it under the terms of the GNU Lesser General Public
57 License as published by the Free Software Foundation; either
58 version 2.1 of the License, or (at your option) any later version.
60 This library is distributed in the hope that it will be useful,
61 but WITHOUT ANY WARRANTY; without even the implied warranty of
62 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
63 Lesser General Public License for more details.
65 You should have received a copy of the GNU Lesser General Public
66 License along with this library; if not, write to the Free Software
67 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</code></pre>
68 <h1 id="acknowledgement"><span class="header-section-number">3</span> Acknowledgement</h1>
69 <p>The following third-party code is used in the MUtilities library:</p>
70 <ul>
71 <li><p><strong>Keccak/SHA-3 Reference Implementation</strong><br />
72 Implementation by the Keccak, Keyak and Ketje Teams, namely, Guido Bertoni, Joan Daemen, Michaël Peeters, Gilles Van Assche and Ronny Van Keer<br />
73 No Copyright / Dedicated to the Public Domain</p></li>
74 <li><p><strong>Natural Order String Comparison</strong><br />
75 Copyright (C) 2000, 2004 by Martin Pool <script type="text/javascript">
76 <!--
77 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;
78 document.write('<a h'+'ref'+'="ma'+'ilto'+':'+e+'" clas'+'s="em' + 'ail">'+e+'<\/'+'a'+'>');
79 // -->
80 </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 />
81 Released under the zlib License</p></li>
82 <li><p><strong>Adler-32 Checksum Algorithm (from zlib)</strong><br />
83 Copyright (C) 1995-2013 Jean-loup Gailly and Mark Adler<br />
84 Released under the zlib License</p></li>
85 </ul>
86 <p> </p>
87 <p><strong>e.o.f.</strong></p>
88 </body>
89 </html>