From 4d2b4cf6f0c4347c9a5269d8f241bcd9bd1d9f56 Mon Sep 17 00:00:00 2001 From: LoRd_MuldeR Date: Sat, 16 Apr 2016 14:25:52 +0200 Subject: [PATCH] Updated README file. --- README.html | 128 ++++++++++++++++++++++++++++---------------- README.md | 49 +++++++++++++++++ etc/style/style.css | 17 ++++++ z_mkdocs.bat | 30 +++++++++++ 4 files changed, 179 insertions(+), 45 deletions(-) create mode 100644 README.md create mode 100644 etc/style/style.css create mode 100644 z_mkdocs.bat diff --git a/README.html b/README.html index 1f1f3fd..70fd323 100644 --- a/README.html +++ b/README.html @@ -1,51 +1,89 @@ - + - MUtilites - - - + + + + + MUtilities – README + + + -

MUtilities – MuldeR's Utilities for Qt

-

Please visit http://muldersoft.com/ or https://github.com/lordmulder for more information!

-
-

About this Library

-

This 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 various other OpenSource projects. -

-

License Information

-

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-2016 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.
-
-

Acknowledgement

-

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

-
-

e.o.f.

+
+

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 various other OpenSource projects.

+

2 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-2016 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.
+

3 Acknowledgement

+

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

+ +

 

+

e.o.f.

diff --git a/README.md b/README.md new file mode 100644 index 0000000..3dfe755 --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +% MUtilities – README +% Created by LoRd_MuldeR <> – check for news and updates! + +# Introduction # + +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 – 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 various [*other OpenSource projects*](https://github.com/lordmulder). + + +# License + +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). + + MUtilities - MuldeR's Utilities for Qt + Copyright (C) 2004-2016 LoRd_MuldeR . 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. + + +# Acknowledgement + +The following third-party code is used in the MUtilities library: + +* **Keccak/SHA-3 Reference Implementation** + Implementation by the Keccak, Keyak and Ketje Teams, namely, Guido Bertoni, Joan Daemen, Michaël Peeters, Gilles Van Assche and Ronny Van Keer + No Copyright / Dedicated to the Public Domain + +* **Natural Order String Comparison** + Copyright (C) 2000, 2004 by Martin Pool + Released under the zlib License + +* **Adler-32 Checksum Algorithm (from zlib)** + Copyright (C) 1995-2013 Jean-loup Gailly and Mark Adler + Released under the zlib License + +  + +**e.o.f.** diff --git a/etc/style/style.css b/etc/style/style.css new file mode 100644 index 0000000..558bc3d --- /dev/null +++ b/etc/style/style.css @@ -0,0 +1,17 @@ + diff --git a/z_mkdocs.bat b/z_mkdocs.bat new file mode 100644 index 0000000..c8d7561 --- /dev/null +++ b/z_mkdocs.bat @@ -0,0 +1,30 @@ +@echo off +setlocal EnableDelayedExpansion + +:: ------------------------------------------ +:: Setup Paths +:: ------------------------------------------ + +set "PATH_PANDOC=C:\Program Files (x86)\Pandoc" + +:: ------------------------------------------ +:: Create Documents +:: ------------------------------------------ + +echo =========================================================================== +echo Building software documentation..." +echo =========================================================================== +echo. + +for %%i in ("%~dp0\*.md") do ( + echo PANDOC: %%~nxi + "%PATH_PANDOC%\pandoc.exe" --from markdown_github+pandoc_title_block+header_attributes --to html5 --toc -N --standalone -H "%~dp0\etc\style\style.css" "%%~i" --output "%%~dpni.html" + if not "!ERRORLEVEL!"=="0" ( + echo. + echo Something went wrong^^! + echo. + pause && exit + ) +) + +echo.