Add maven build and run instructions

git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@896751 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 46 insertions, 5 deletions

diff --git a/sandbox/travelsample/README b/sandbox/travelsample/README
index 1f42129160..eb77688add 100644
--- a/sandbox/travelsample/README
+++ b/sandbox/travelsample/README
@@ -1,3 +1,4 @@
+

 Building the travel sample using ant

 ------------------------------------

 

@@ -21,16 +22,35 @@ Building the travel sample using ant
 7. With the travelsample directory as your current directory, enter the

    command "ant compile".

 

+

 Building the travel sample using maven

 --------------------------------------

 

-To be added.

+Most of the steps are similar to the above.  For completeness, a full list

+of the steps needed is given here.

+

+1. Download and unzip JDK 1.6.0_07 or later and set the JAVA_HOME environment

+   variable to the JDK base directory.

+2. Install svn and maven.

+3. Create a local directory to hold the travel sample code.  With this as

+   your current directory, check out the complete travel sample from svn

+   using the following command:

+     svn co http://svn.apache.org/repos/asf/tuscany/sandbox/travelsample

+4. Check the setting of the <tuscany.version> property in the

+   travelsample/pom.xml file.  If you want to build the travel sample using

+   a different Tuscany version, change this property as necessary.

+5. With the travelsample directory as your current directory, enter the

+   command "mvn".  You will need a live internet connection so that maven

+   can download any required files to your local repository.

 

-Running the travel sample

--------------------------

 

-The travel sample consists of a number of related scenarios.  These are

-listed below, together with instructions for running them.

+Running the travel sample from the build directories

+----------------------------------------------------

+

+The travel sample consists of a number of related scenarios.  These scenarios

+are listed below, together with instructions for running them.  The instructions

+in this section will work irrespective of whether the travel sample was built

+using ant or maven.

 

 Most of the scenarios are run by opening a single command prompt window

 and entering the command "ant run" into that window.  If a scenario is

@@ -212,3 +232,24 @@ Commands: ant run-smsgateway, ant run
 Contributions: notification, notification-ws

 Launchers: common

 Services: smsgateway-jaxws

+

+

+Running the travel sample from the distribution directories

+-----------------------------------------------------------

+

+If the travel sample was built using maven, a binary distribution

+directory will be created containing all the built jar files together with

+a "lib" directory containing a complete set of runtime dependencies for

+these jar files.  The jar files in the "launchers" directory in the

+distribution output can be run using the command

+

+ java -jar <distribution-jar>

+

+where <distrbution-jar> is the name of the jar file in the distrbution

+directory tree.  For example, to run the "jumpstart" scenario, you

+would use the command

+

+ java -jar <your-path>/scatours-launcher-jumpstart.jar

+

+It isn't possible currently to run scenarios 3 and 6 (distributed execution

+with a domain manager) from the distribution directory in this way.