README

################################################################################
# Copyright (c) 2015, Mohamed REZGUI - University of Nice Sophia Antipolis     #                                        
# All rights reserved.                                                         #
# Redistribution and use in source and binary forms, with or without           #
# modification, are permitted provided that the following conditions are met:  #
#                                                                              #
#     * Redistributions of source code must retain the above copyright         #
#       notice, this list of conditions and the following disclaimer.          #
#     * Redistributions in binary form must reproduce the above copyright      #
#       notice, this list of conditions and the following disclaimer in the    #
#       documentation and/or other materials provided with the distribution.   #
#     * Neither the name of Mohamed REZGUI nor the			       #
#       names of its contributors may be used to endorse or promote products   #
#       derived from this software without specific prior written permission.  #
#                                                                              #
# THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY  #
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED    #
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE       #
# DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY #
# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES   #
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; #
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND  #
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT   #
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS#
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                 #
################################################################################

 eps-gecode : use the power of embarrassingly parallel to solve CP problems
 eps-gecode is a c++ library for solving problems.
== README ==

 1. PREREQUISITES
 2. BUILDING
 3. INSTALLING
 4. EXECUTING
 5. DOCUMENTATION
 6. RELEASE
 7. CONTRIBUTING
 
== 1. PREREQUISITES ==
 This project works on 32 bits and 64 bits environment. 
 This project requires:
 
  * Cross-platform Make (CMake) v2.8+
  	> Fedora :
	  	yum install cmake
  	> Ubuntu :
 		apt-get install cmake
  	
  * GNU Make or equivalent.
  	> Fedora :
  		yum install make
  	> Ubuntu :
 		apt-get install make	
  	
  * GCC or an alternative, reasonably conformant C++ compiler (atomic operations is used if g++ 4.4+ (C++0x features))
  	> Fedora :
  		yum groupinstall "Development Tools"
  	> Ubuntu :
 		apt-get install build-essential	

  * Gecode 
	install it by executing the script install_gecode.sh
     
== 2. BUILDING ==
 

 This project uses the Cross-platform Make (CMake) build system. However, we
 have conveniently provided a wrapper configure script and Makefile so that
 the typical build invocation of "./configure" followed by "cmake" will work.
 For a list of all possible build targets, use the command "make help".

 NOTE: Users of CMake may believe that the top-level Makefile has been
 generated by CMake; it hasn't, so please do not delete that file.

== 3. INSTALLING ==

 Once the project has been built (see "BUILDING"), execute "make".

== 4. EXECUTING ==

 Once the project has been installed (see "INSTALLING")
 and execute "bin/Release/eps-gecode".

 That's options can be used for the program :
 
	TODO : Add flags
 
== 5. DOCUMENTATION ==
 
 TODO

== 6. CONTRIBUTING ==

 Mohamed REZGUI : PHD Student of Doctoral School STIC based on I3S Lab