Read Me

Author : Matan Zruya (mzruya@gmail.com)
Date : 13/12/2012

1. Project Structure :
----------------------
finite-sat
    finite-sat-api - should contains only pojo's and interfaces
    finite-sat-impl - implementations for the interfaces and usages of the pojos
test-framework - the testing framework code, some junit custom class runners and test annotations to be
                 used across the application unit tests
use - the bgu modified use source files
externalLibs - the third-party jars that are needed

in a perfect world 'use' would also have use-api and use-impl,
in addition to that 'finite-sat-impl' contains a lot of api classes.

2. How to run ?
---------------
this is a standard maven project, so make sure u have a working maven install, 'cd' to the the project dir
and run "mvn clean install", this will compile the project and run all unit tests

3. Installing Maven :
---------------------
download the latest version from : http://maven.apache.org/download.cgi
installing is basically unpacking the zip file and configuring some system variables
usually M2_HOME and JAVA_HOME,
detailed instruction for windows and linux are the the bottom of the page http://maven.apache.org/download.cgi

3. How to open in my favorite IDE ?
-----------------------------------
all modern IDE's (eclipse and intellij) support maven, intellij does so out of the box, so u can just try to open the main
pom.xml file as a project and intellij will import it.
With eclipse it is necessary to download the maven eclipse plugin and follow it's instructions.

my personal suggestion is to use the free Intellij community edition, it surpasses eclipse in every aspect
http://www.jetbrains.com/idea/ and has built in support for everything eclipse requires a plugin,
it is much faster and more responsive.

Intellij :
* File -> New Project -> From existing maven module, and then choose the project root
* File -> Open -> then select the pom.xml in the root of the project

Eclipse :
install the e2m plugin if not already installed : Help -> Enter market place -> search "maven" -> select the "Maven integration for Eclipse" plugin and install it
then just import the project by choosing File -> Import -> Maven -> Existing Maven Project

4. Local project settings :
---------------------------
each IDE has it's own mechanism for saving project settings,
intellij - saves .iml file and .idea directories
eclipse - .project .classpath files and .settings folder

as a rule project settings are not delivered with this project and should be passed along between developers,
don't break the rule because it will break your local project, NEVER COMMIT THESE FILES

4. Maven ?!?!?
--------------
u write java code and haven't heard of maven yet ?!? it's gonna change the way u do java from now on,
go to http://maven.apache.org/ and read some tutorials.