diff options
Diffstat (limited to 'sca-java-1.x/trunk/samples/README')
| -rw-r--r-- | sca-java-1.x/trunk/samples/README | 55 |
1 files changed, 31 insertions, 24 deletions
diff --git a/sca-java-1.x/trunk/samples/README b/sca-java-1.x/trunk/samples/README index 9d4bad1fc4..9fdbd78fdc 100644 --- a/sca-java-1.x/trunk/samples/README +++ b/sca-java-1.x/trunk/samples/README @@ -138,9 +138,9 @@ Getting Ready To Build ---------------------- You will need to install the following software before you start. -J2SE Development Kit (JDK) 5.0 -Apache Ant 1.7.0 - if you are going to use Ant -Apache Maven 2.0.6 - if you are going to use Maven +J2SE Development Kit (JDK) 5.0 or higher +Apache Ant 1.7.1 or higher - if you are going to use Ant +Apache Maven 2.0.10 or higher - if you are going to use Maven Java and Ant and/or Maven binary directories must be present in your PATH so that their executable programs are available in your environment. You may @@ -148,15 +148,15 @@ find it useful to use a script to set up your environment, for example; For UNIX: JAVA_HOME=/<installation_directory> - ANT_HOME=/<installation_directory>/apache-ant-1.7.0 - MAVEN_HOME=/<installation_directory>/maven-2.0.6 - export PATH=$JAVA_HOME/bin:$ANT_HOME/bin:$MAVEN_HOME/bin:$PATH + ANT_HOME=/<installation_directory>/apache-ant-1.7.1 + M2_HOME=/<installation_directory>/maven-2.0.10 + export PATH=$JAVA_HOME/bin:$ANT_HOME/bin:$M2_HOME/bin:$PATH For Windows: set JAVA_HOME=C:\<installation_directory> - set ANT_HOME=C:\<installation_directory>\apache-ant-1.7.0 - set MAVEN_HOME=C:\<installation_directory>\maven-2.0.6 - set PATH=%JAVA_HOME%\bin;%ANT_HOME%\bin;%MAVEN_HOME%\bin;%PATH% + set ANT_HOME=C:\<installation_directory>\apache-ant-1.7.1 + set M2_HOME=C:\<installation_directory>\maven-2.0.10 + set PATH=%JAVA_HOME%\bin;%ANT_HOME%\bin;%M2_HOME%\bin;%PATH% Building And Running The SCA Samples Using Ant @@ -236,7 +236,7 @@ The Maven build process will work from both source and binary distributions. To build and test all of the Apache Tuscany SCA sources, including the samples, do the following. -cd sca +cd samples mvn This will take a little while to complete. Experience with Maven tells us that @@ -254,31 +254,38 @@ When using Maven the samples are run within JUnit test cases and so you will sometimes not see any test output. You will always see an indication of test success or failure. + Using The Samples In An IDE ---------------------------------------------- +--------------------------- The easiest way to use the samples in an IDE is to use Maven to generate all -of the IDE project files for you automatically. This works best if you -generate IDE projects for all of the Apache Tuscany modules. You can then -include the ones you are interested in working with in you IDE. +of the IDE project files for you automatically. + +If you are using the Apache Tuscany SCA source distribution, you can find +details of how to generate IDE project files (including IDE project files +for the samples) in the "Using an IDE" section of the BUILDING file. -To build IDE project files for all of the modules in Apache Tuscany SCA; +If you are using the Apache Tuscany SCA binary distribution, follow these +steps to generate IDE project files for all of the samples; -cd sca +cd samples If you are an Eclipse user do the following -mvn -Peclipse eclipse:eclipse +mvn eclipse:eclipse +mvn -Declipse.workspace=<path-to-eclipse-workspace> eclipse:add-maven-repo If you are an IDEA user do the following mvn idea:idea -These commands generate project files for each module in Apache Tuscany SCA. -The modules you are interested in can now be included in your IDE, for example, -in Eclipse, if you create a new Java project and use the option to "create a -new project from existing source" you can specify an SCA module directory, -which includes the generated project files, and Eclipse will treat it like any -other Java project. +These commands generate project files for each module in the samples directory. +The modules you are interested in can now be included in your IDE. + +For example, in Eclipse, if you create a new Java project and use the option +to "create a new project from existing source" you can specify an SCA module +directory, which includes the generated project files, and Eclipse will treat +it like any other Java project. + Using The Samples In An IDE Without Maven ----------------------------------------- @@ -290,7 +297,7 @@ In a new or existing workspace Create a new java project to represent the sample you want to work on, e.g. calculator Import all of the sample code and resources into this project, e.g. - File, Import and then select tuscany-sca-1.0-incubating\samples\calculator from the filesystem + File, Import and then select samples/calculator from the filesystem Configure the source path to include src/main/java src/main/resources |