Merge branch 'master' of https://github.com/MultithreadCorner/MCBooster

Author: Augusto

README.md

@@ -16,7 +16,7 @@ The latest version can be found on the
 Documentation
 -------------
 
-The complete and updated [Doxygen](www.doxygen.org/) source code documentation of this release is available in HTML format on the
+The complete and updated [Doxygen](http://www.doxygen.org/) source code documentation of this release is available in HTML format on the
 [reference manual](http://multithreadcorner.github.io/MCBooster/) webpage.
 User can also browse the documentation by class, file or name using the following links:
 

mcbooster/MCBooster.h

@@ -2,3 +2,73 @@
 #define MCBooster_VERSION_MAJOR 1
 #define MCBooster_VERSION_MINOR 0
 #define MCBooster_VERSION_PATCH 0
+/**
+ \mainpage
+ 
+ MCBooster
+=========
+
+What is it?
+-----------
+MCBooster is an header only library designed for the fast generation of
+phase space events. The library make use of thrust library and can deploy OpenMP
+threads, CUDA and Xeon Phi cores. It is focused on performance and precision.  
+
+The Latest Version
+------------------
+
+The latest version can be found on the 
+[project relases page](https://github.com/MultithreadCorner/MCBooster/releases).
+
+Documentation
+-------------
+
+The complete and updated [Doxygen](http://www.doxygen.org/) source code documentation of this release is available in HTML format on the
+[reference manual](http://multithreadcorner.github.io/MCBooster/) webpage.
+User can also browse the documentation by class, file or name using the following links:
+
+1.[classe](http://multithreadcorner.github.io/MCBooster/classes.html)
+
+2.[file](http://multithreadcorner.github.io/MCBooster/files.html)
+
+3.[name](http://multithreadcorner.github.io/MCBooster/namespacemembers.html)
+
+
+Examples
+--------
+
+Some example code samples demonstrating the basic usage of the library are stored in the src directory. 
+These samples can be built using [CMAKE](https://cmake.org/) according the following instructions:
+
+1. clone the git repository: `git clone https://github.com/MultithreadCorner/MCBooster.git`
+2. go to MCBooster directory: `cd MCBooster`
+3. create a build directory: `mkdir build` 
+4. `cmake ../`
+5. `make`
+
+The targets will be installed into directory-of-the-project/bin. To run an example do ./example-name
+
+Installation and requirements 
+-----------------------------
+
+MCBooster is a header only library, so no build process is necessary to install it.
+The library run on Linux systems and requires C++11 and the [Thrust library](https://thrust.github.io/). The code samples require [ROOT](https://root.cern.ch/) and [TCLAP](http://tclap.sourceforge.net/) library. 
+CUDA based projects will require a local installation of [CUDA Tookit](https://developer.nvidia.com/cuda-toolkit) with version 6.5 or higher.  
+Alternatively, projects the targeting [OpenMP](http://openmp.org/wp/) backend can be compiled with nvcc or gcc directly. 
+
+Licensing
+---------
+
+MCBooster is released under the [GNU General Public License version 3](http://www.gnu.org/licenses/gpl-3.0.en.html). Please see the file called [COPYING](https://github.com/MultithreadCorner/MCBooster/blob/master/COPYING).
+
+Author
+--------
+
+MCBooster is developed and mantained by [Antonio Augusto Alves Jr](@AAAlvesJr).
+
+Acknowledgement
+---------------
+
+MCBooster's development has been supported by the [National Science Foundation](http://nsf.gov/index.jsp) under grant number [PHY-1414736](http://nsf.gov/awardsearch/showAward?AWD_ID=1414736). Any opinions, findings, and conclusions or recommendations expressed in this material are those of the developers and do not necessarily reflect the views of the National Science Foundation.
+
+ */