diff options
Diffstat (limited to 'sca-java-2.x/trunk/samples/getting-started/helloworld-contribution/README')
-rw-r--r-- | sca-java-2.x/trunk/samples/getting-started/helloworld-contribution/README | 41 |
1 files changed, 35 insertions, 6 deletions
diff --git a/sca-java-2.x/trunk/samples/getting-started/helloworld-contribution/README b/sca-java-2.x/trunk/samples/getting-started/helloworld-contribution/README index ed0f1d0ce4..34c4b3a788 100644 --- a/sca-java-2.x/trunk/samples/getting-started/helloworld-contribution/README +++ b/sca-java-2.x/trunk/samples/getting-started/helloworld-contribution/README @@ -1,7 +1,36 @@ -The README in the <distribution-unpack-dir>/samples directory provides
-general instructions about building and running samples. (where
-distribution-unpack-dir is the directory in which you unpacked the tuscany
-binary distribution archive). Take a look there first (noting at you read it that this sample
-is not a new style sample).
+Tuscany - Getting Started - Helloworld Sample
+---------------------------------------------
+
+This sample demonstrates a simple helloworld style SCA application and how to run that with Tuscany.
+
+See the README in the top-level samples folder for general information on the Tuscany samples.
+
+This project creates a jar format SCA contribution which has a deployable SCA composite. The composite
+defines a single component named "HelloworldComponent" which implements a Helloworld service which
+is implemented by a Java class. A JUnit testcase tests running the composite and invoking the service.
+
+You can use the contribution built in the Tuscany Shell - at the root of a Tuscany binary distribution
+run the following command:
+
+ bin\tuscany.bat samples\getting-started\helloworld-contribution
+
+You may then call the helloworld service with the shell command:
+
+ invoke HelloworldComponent sayHello "your name"
+
+
+---
+
+This sample was created by the Tuscany contribution-jar Maven archetype. You can use that archetype to
+create you own SCA contribution projects by running the following maven command:
+
+ mvn archetype:generate -DarchetypeCatalog=http://tuscany.apache.org
+
+at the prompt select 1 to choose the contribution-jar archetype and then answer the questions. This project
+used the following answers:
+
+ Define value for property 'groupId': : org.apache.tuscany.sca.samples
+ Define value for property 'artifactId': : helloworld-contribution
+ Define value for property 'version': 1.0-SNAPSHOT: 2.0-SNAPSHOT
+ Define value for property 'package': org.apache.tuscany.sca.samples: sample
-TODO - finish this
\ No newline at end of file |