Some more documentation updates.

[mutilities/MUtilities.git] / docs / index.html

diff --git a/docs/index.html b/docs/index.html
index 565e796..e4c1d3b 100644 (file)
--- a/docs/index.html
+++ b/docs/index.html
@@ -65,19 +65,6 @@ $(function() {
 <div class="contents">
 <div class="textblock"><h1>Introduction</h1>
 <p>The <b>MUtilities</b> 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 "side product" of the <a href="http://lamexp.sourceforge.net/"><b>LameXP</b></a> application: Over the years, a lot of code, <b>not</b> 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 "copy &amp; 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 <b>MUtilities</b> (aka "MuldeR's Utilities for Qt") 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>
-<h1>Project Structure</h1>
-<p>The <em>MUtilities</em> project directory is organized as follows:</p>
-<ul>
-<li><code>bin/</code> &ndash; compiled library files (static or shared), link those files in projects that use the MUtilities library</li>
-<li><code>docs/</code> &ndash; programming interface documentation, generated with Doxygen tool</li>
-<li><code>etc/</code> &ndash; miscellaneous files, everything that doesn't fit in anywhere else</li>
-<li><code>include/</code> &ndash; public header files, include this directory in projects that use the MUtilities library</li>
-<li><code>obj/</code> &ndash; object code files, intermediate files generated during the build process</li>
-<li><code>res/</code> &ndash; resource files, required for building the MUtilities library</li>
-<li><code>src/</code> &ndash; source code files, required for building the MUtilities library (third-party code in <code>src/3rd_party/</code>)</li>
-<li><code>test/</code> &ndash; unit tests, based on Google Test framework</li>
-<li><code>tmp/</code> &ndash; temporary files, automatically generated during the build process</li>
-</ul>
 <h1>API Documentation</h1>
 <p>The public API of the <em>MUtilities</em> library is defined in the following header files (select file for details):</p><ul>
 <li><b><a class="el" href="d5/d3b/_global_8h.html" title="This file contains miscellaneous functions that are generally useful for Qt-based applications...">Global.h</a></b> &ndash; miscellaneous useful functions</li>
@@ -90,14 +77,7 @@ int main(int argc, char **argv)
 {
     qDebug("Random number: %u\n", MUtils::next_rand_u32());
 }
-</pre><h2>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 "Additional Include Directories" and that the <em>MUtilities'</em> <code>bin/</code> directory is contained in your "Additional Library Directories".</li>
-<li>Finally, make sure that your project links against the <code>MUtils32-1.lib</code> library file. For each build configuration, pick the proper **.lib** file from the corresponding <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 <b>static</b> library, then the macro <code>MUTILS_STATIC_LIB</code> <em>must</em> be added to your project's "Preprocessor Definitions".</li>
-</ul>
-<h1>License</h1>
+</pre><h1>License</h1>
 <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><pre class="fragment">MUtilities - MuldeR's Utilities for Qt
 Copyright (C) 2004-2016 LoRd_MuldeR &lt;MuldeR2@GMX.de&gt;. Some rights reserved.