Bump version.

[mutilities/MUtilities.git] / README.md

diff --git a/README.md b/README.md
index 8df2249..59c0ad8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,19 +8,39 @@ The **MUtilities** library is a collection of routines and classes to extend the
 
 # Project Structure
 
-The *MUtilities* project directory is structured as follows:
+The *MUtilities* project directory is organized as follows:
 
 * `bin/` – compiled library files (static or shared), link those files in projects that use the MUtilities library
 * `docs/` – programming interface documentation, generated with Doxygen tool
 * `etc/` – miscellaneous files, everything that doesn't fit in anywhere else
 * `include/` – public header files, include this directory in projects that use the MUtilities library
 * `obj/` – object code files, intermediate files generated during the build process
-* `res/` – resouce files, required for building the MUtilities library
+* `res/` – resource files, required for building the MUtilities library
 * `src/` – source code files, required for building the MUtilities library (third-party code in `src/3rd_party/`)
 * `test/` – unit tests, based on Google Test framework
 * `tmp/` – temporary files, automatically generated during the build process
 
 
+# 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());
+    }
+
+## Build Notes
+
+* In order to use the *MUtilities* library in your project, your build environment must have already been set up for building Qt-based projects. Setting up Qt is *not* covered by this document.
+* Additionally, make sure that *MUtilities'* `include/` directory is contained in your "Additional Include Directories" and that the *MUtilities'* `bin/` directory is contained in your "Additional Library Directories".
+* Finally, make sure that your project links against the `MUtils32-1.lib` library file. For each build configuration, pick the proper **.lib** file from the corresponding `bin/<platform>/<config>/` directory!
+* If your projects intends to use the *MUtilities* library as a **static** library, then the macro `MUTILS_STATIC_LIB` *must* be added to your project's "Preprocessor Definitions".
+
+
 # API Documentation
 
 A fully-fledged documentation of the *MUtilities* programming interface (API) is available thanks to [*Doxygen*](http://www.stack.nl/~dimitri/doxygen/). Please see [**`docs/index.html`**](docs/index.html) for details!
@@ -31,7 +51,7 @@ A fully-fledged documentation of the *MUtilities* programming interface (API) is
 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 <MuldeR2@GMX.de>. Some rights reserved.
+    Copyright (C) 2004-2023 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
@@ -50,6 +70,11 @@ This library is free software. It is released under the terms of the [*GNU Lesse
 
 # Acknowledgement
 
+The following people have contributed in the development of the MUtilities library:
+
+* **John Buonagurio &lt;<jbuonagurio@exponent.com>&gt;**  
+  Support for Qt5
+
 The following third-party code is used in the MUtilities library:
 
 * **Keccak/SHA-3 Reference Implementation**  
@@ -57,7 +82,7 @@ The following third-party code is used in the MUtilities library:
   No Copyright / Dedicated to the Public Domain
 
 * **Natural Order String Comparison**  
-  Copyright (C) 2000, 2004 by Martin Pool <mbp@sourcefrog.net>  
+  Copyright (C) 2000, 2004 by Martin Pool &lt;<mbp@sourcefrog.net>&gt;  
   Released under the zlib License
 
 * **Adler-32 Checksum Algorithm (from zlib)**