Some documentation updates.

[mutilities/MUtilities.git] / README.md

diff --git a/README.md b/README.md
index 8df2249..50b8267 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ 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
@@ -21,6 +21,26 @@ The *MUtilities* project directory is structured as follows:
 * `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 you have to pick the proper **.lib** file from the correspnding `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!