From 52f7f83e0dea6bae1468726bc2f471f75be34462 Mon Sep 17 00:00:00 2001
From: boufaras <boufaras@331e1502-861f-0410-8da2-ba01fb791d7f>
Date: Mon, 24 Oct 2011 10:07:45 +0000
Subject: [PATCH] git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@2485
 331e1502-861f-0410-8da2-ba01fb791d7f

---
 trunk/paradiseo-gpu/README.txt | 81 ++++++++++++++++++++++++++++++++++
 1 file changed, 81 insertions(+)
 create mode 100644 trunk/paradiseo-gpu/README.txt

diff --git a/trunk/paradiseo-gpu/README.txt b/trunk/paradiseo-gpu/README.txt
new file mode 100644
index 000000000..89e4b0c55
--- /dev/null
+++ b/trunk/paradiseo-gpu/README.txt
@@ -0,0 +1,81 @@
+                PARADISEO-GPU README FILE
+=======================================================================
+         check latest news at http://paradiseo.gforge.inria.fr/
+=======================================================================
+
+Welcome to ParadisEO-GPU, the reusable design and implementation of parallel meta-
+heuristics on Graphics Processing Units (GPU).
+The latest news about ParadisEO-GPU can be found on the gforge repository at
+http://paradiseo.gforge.inria.fr/index.php?n=Doc.API
+In case of any problem, please e-mail us at
+paradiseo-help@lists.gforge.inria.fr
+
+
+
+=======================================================================
+                        BUILDING PARADISEO-PEO
+=======================================================================
+The basic installation procedure goes the following.
+
+To compile paradiseo-gpu in the default directory,
+go to paradiseo-gpu/build/ and run:
+    > cmake ..
+    > make
+    // for an easy-use of the provided lessons
+    > make install
+    // optional (if the documentation is not already available)
+    > make doc
+
+To compile paradiseo-peo anywhere else, simply run:
+    > cmake $(GPU) -Dconfig=<path to the install.cmake file>
+    > make
+    // for an easy-use of the provided lessons
+    > make install
+    // optional (if the documentation is not already available)
+    > make doc
+
+To clean everything, simply run
+    > make clean
+
+
+===================================================================
+                       DIRECTORY STRUCTURE
+===================================================================
+After unpacking the archive file, you should end up with the following
+structure:
+
+.../                     The main PARADISEO-GPU directory, created when unpacking.
+   |
+   +-- build             BUILD directory that contains libraries and executable files.
+   |
+   +-- src               SOURCE directory Contains most PARADISEO-GPU .h files. 
+   |   
+   +-- doc               DOCUMENTATION directory (generated by Doxygen).
+   |   |
+   |   +- html           HTML files - start at index.html. 
+   |   |
+   |   +- latex          latex files - use to generate Postcript doc.
+   |   |
+   |   +- man            Unix man format documentation.
+   |
+   |
+   +-- tutorial          APPLICATIONS
+       |
+       +-- INSTANCES       The instances problem directory (QAP instances ...)
+       |
+       +-- OneMax          How make One max problem with parallel evalution of neighborhood(bit flipping) with hamming distances =1
+       |
+       +-- KswapOneMax     How make One max problem with parallel evalution of neighborhood(bit flipping) with hamming distances >=1
+       |
+       +-- PPP_GPU         How make Permuted Perceptron Problem with parallel evalution of neighborhood on GPU
+       |
+       +-- QAP_GPU         How make Quadratic Assignement Problem  with parallel evaluation of neighborhood on GPU
+       |
+       +-- QAP_CPU         How make Quadratic Assignement Problem  with sequentiel evaluation of neighborhood on CPU
+       
+
+===================================================================
+              NOTES
+===================================================================
+
+Mailing list : paradiseo-help@lists.gforge.inria.fr