| commit | d6d728539f39beedd7cac49989f53badef942ba0 | [log] [tgz] |
|---|---|---|
| author | Dale LaBossiere <dlaboss@us.ibm.com> | Tue Sep 26 15:12:20 2017 -0400 |
| committer | Dale LaBossiere <dlaboss@us.ibm.com> | Tue Sep 26 15:12:20 2017 -0400 |
| tree | c022346d065e4e29cd4fa59ddb5f18b5ee6cd260 | |
| parent | 150c308d2f45be0ed029f1728a47911d2899db5c [diff] |
Adjust javadoc overview.html for getting started and samples
See APPLICATION_DEVELOPMENT.md for general information on Edgent Application Development, Packaging and Execution.
Additional information may also be found in Getting Started https://edgent.apache.org/docs/edgent-getting-started
Once you have downloaded and unpacked the samples source bundle or cloned the the samples repository you need to download these additional development software tools.
Maven is used as build tool. Currently there are two options:
mvnw or mvnw.bat command - preferred)mvn command)The maven-wrapper will automatically download and install the correct Maven version and use that. Besides this, there is no difference between using the mvn and mvnw command.
You may also use a maven-integrated IDE with the samples. e.g., see the Using Eclipse section below.
The samples use Edgent SDK jars that have been released in a maven repository such as Maven Central.
Alternatively, you can download the Edgent SDK sources and build them, populating your local maven repository. The samples will then use those Edgent SDK jars. Adjust the edgent.version property in the top level samples pom.xml accordingly. See downloads for downloading the Edgent SDK sources.
By default Java8 class files are generated. Java7 platform class files are produced when the appropriate profile is specified.
Currently, building and running the samples for the Android platform is not supported. Many samples use the DevelopmentProvider and the DevelopmentProvider is not supported on the Android platform.
Build the samples
./mvnw clean package # -Pplatform-java7 as needed
A standard jar and uber jar are created for each sample category in the sample category's target directory: <category>/target.
See the README.md in each sample category directory.
The Edgent Git repository, or samples source release bundle, contains Maven project definitions for the samples.
Once you import the Maven projects into your workspace, builds in Eclipse use the same artifacts as the Maven command line tooling. Like the command line tooling, the jars for dependent projects are automatically downloaded to the local maven repository and used.
If you want to use Eclipse to clone your fork, use the Eclipse Git Team Provider plugin
git@github.com:<username>/incubator-edgent.git). The other fields will be populated automatically. Click Next. If required, enter your passphrase.master) and click NextOnce you have cloned the Git repository to your machine or are working from an unpacked samples source release bundle, import the Maven projects into your workspace
samples directory in the clone or source release directory and select it. A hierarchy of samples projects / pom.xml files will be listed and all selected.Top-level artifacts such as README.md are available under the edgent-samples project.
Note: Specifics may change depending on your version of Eclipse or the Eclipse Maven or Git Team Provider.
Once the samples projects have been imported you can run them as any Eclipse application. E.g.,
HelloEdgent.java sampleHelloEdgent runs and prints to the Console view.Other samples are provided but have not yet been fully documented. Feel free to explore.