[jboss-svn-commits] JBL Code SVN: r20452 - in labs/jbossrules/trunk/drools-solver/src/main/assembly: docs and 1 other directories.

[jboss-svn-commits at lists.jboss.org]

Author: ge0ffrey
Date: 2008-06-12 15:01:25 -0400 (Thu, 12 Jun 2008)
New Revision: 20452

Added:
   labs/jbossrules/trunk/drools-solver/src/main/assembly/docs/
   labs/jbossrules/trunk/drools-solver/src/main/assembly/docs/ReadMeDroolsSolver.txt
   labs/jbossrules/trunk/drools-solver/src/main/assembly/scripts/runExamples.bat
Modified:
   labs/jbossrules/trunk/drools-solver/src/main/assembly/bin.xml
Log:
ReadMe for drools solver and bat file

Modified: labs/jbossrules/trunk/drools-solver/src/main/assembly/bin.xml
===================================================================
--- labs/jbossrules/trunk/drools-solver/src/main/assembly/bin.xml	2008-06-12 18:21:22 UTC (rev 20451)
+++ labs/jbossrules/trunk/drools-solver/src/main/assembly/bin.xml	2008-06-12 19:01:25 UTC (rev 20452)
@@ -22,6 +22,11 @@
             <filtered>true</filtered>
             <outputDirectory/>
         </fileSet>
+        <fileSet>
+            <directory>src/main/assembly/docs</directory>
+            <filtered>true</filtered>
+            <outputDirectory/>
+        </fileSet>
         <!-- Examples -->
         <fileSet>
             <directory>drools-solver-examples/data/nqueens/unsolved</directory>

Added: labs/jbossrules/trunk/drools-solver/src/main/assembly/docs/ReadMeDroolsSolver.txt
===================================================================
--- labs/jbossrules/trunk/drools-solver/src/main/assembly/docs/ReadMeDroolsSolver.txt	                        (rev 0)
+++ labs/jbossrules/trunk/drools-solver/src/main/assembly/docs/ReadMeDroolsSolver.txt	2008-06-12 19:01:25 UTC (rev 20452)
@@ -0,0 +1,33 @@
+Welcome to drools-solver
+========================
+
+State
+-----
+
+Drools Solver is still in an alfa state: backward incompatible changes may occur in the next version.
+
+Run the examples
+----------------
+
+To run the examples, run either of these:
+Linux, Cygwin: ./runExamples.sh
+Windows: runExamples.bat
+
+Using drools-solver with maven 2
+--------------------------------
+
+If you're using maven 2 to handle your dependencies,
+the jars and poms should be available in the jboss maven repository:
+  http://repository.jboss.org/maven2/
+You 'll want to add a dependency to drools-solver-core in your project:
+<dependency>
+  <groupId>org.drools.solver</groupId>
+  <artifactId>drools-solver</artifactId>
+  <version>${project.version}</version>
+</dependency>
+
+Using drools-solver otherwise
+-----------------------------
+
+The drools-solver jars are located in the lib directory.
+To use drools-solver, you need all the jars except the drools-solver-examples jar.

Copied: labs/jbossrules/trunk/drools-solver/src/main/assembly/scripts/runExamples.bat (from rev 20450, labs/jbossrules/trunk/drools-solver/src/main/assembly/scripts/runExamples.sh)
===================================================================
--- labs/jbossrules/trunk/drools-solver/src/main/assembly/scripts/runExamples.bat	                        (rev 0)
+++ labs/jbossrules/trunk/drools-solver/src/main/assembly/scripts/runExamples.bat	2008-06-12 19:01:25 UTC (rev 20452)
@@ -0,0 +1,15 @@
+set mainJar=lib\drools-solver-examples-${project.version}.jar
+set mainClass=org.drools.solver.examples.app.ExamplesApp
+
+echo "Usage: runExamples.bat"
+echo "For example: runExamples.bat"
+echo "Some notes:"
+echo "- Working dir should be the directory of this script."
+echo "- Java is recommended to be JDK and java 6 for optimal performance"
+echo "- The environment variable JAVA_HOME should be set to the JDK installation directory"
+echo "  For example: set JAVA_HOME="C:\Program Files\Java\jdk1.6.0"
+echo
+echo "Starting examples app..."
+
+# -Xmx128M or less works too, but it might be slower
+%JAVA_HOME%\bin\java -server -Xmx256M -cp %mainJar% %mainClass%