doc tweaks
Project: http://git-wip-us.apache.org/repos/asf/incubator-edgent/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-edgent/commit/709fb97e Tree: http://git-wip-us.apache.org/repos/asf/incubator-edgent/tree/709fb97e Diff: http://git-wip-us.apache.org/repos/asf/incubator-edgent/diff/709fb97e Branch: refs/heads/develop Commit: 709fb97e31aba65b9a5f43257fb801d25b331b00 Parents: bd059c5 Author: Dale LaBossiere <[email protected]> Authored: Wed Nov 1 09:20:06 2017 -0400 Committer: Dale LaBossiere <[email protected]> Committed: Wed Nov 1 09:20:06 2017 -0400 ---------------------------------------------------------------------- DEVELOPMENT.md | 6 ++++++ samples/APPLICATION_DEVELOPMENT.md | 10 ++++------ samples/README.md | 10 ++++++---- 3 files changed, 16 insertions(+), 10 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/709fb97e/DEVELOPMENT.md ---------------------------------------------------------------------- diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 221f252..5f1c8c8 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -42,6 +42,12 @@ The Ant and Gradle tooling is no longer functional. It's recommended that developers of Edgent create a new workspace instead of reusing current gradle-based Edgent workspaces. +## Branches + +The `develop` branch is used for development. Jenkins is setup to build this branch and publish internal SNAPSHOT build results to the ASF Nexus SNAPSHOTS Repository (https://repository.apache.org/content/repositories/snapshots). + +The `master` branch contains released code. Releases are published to the ASF Nexus Releases Repository (https://repository.apache.org/content/repositories/releases). The Releases repository is automatically mirrored to the Maven Central Repository. + ## Setup Once you have forked the repository and created your local clone you need to download http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/709fb97e/samples/APPLICATION_DEVELOPMENT.md ---------------------------------------------------------------------- diff --git a/samples/APPLICATION_DEVELOPMENT.md b/samples/APPLICATION_DEVELOPMENT.md index eb6e2fb..9e01074 100644 --- a/samples/APPLICATION_DEVELOPMENT.md +++ b/samples/APPLICATION_DEVELOPMENT.md @@ -19,9 +19,11 @@ To develop Edgent applications you will utilize the Edgent SDK/runtime jars and package your application -artifacts for deploying to an edge device for execution. +artifacts for deploying to an edge device or gateway for execution. -The Edgent SDK/runtime jars are published to maven-central. +The Edgent SDK/runtime jars are published to the +[ASF Nexus Repository](https://repository.apache.org/content/repositories/releases/) +and the Maven Central Repository. Alternatively, you can build the Edgent SDK yourself from a source release and the resulting jars will be added to your local maven repository. @@ -129,10 +131,6 @@ for a tool to get a copy of the Edgent jars. The bundle is a standalone entity containing everything that's needed to run your application. - -The bundle contains the application's jar -and the application's dependent Edgent jars and their -transitive dependencies. The bundle is copied to the device and unpacked. A run script forms the appropriate `CLASSPATH` http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/709fb97e/samples/README.md ---------------------------------------------------------------------- diff --git a/samples/README.md b/samples/README.md index e39fac0..09079d4 100644 --- a/samples/README.md +++ b/samples/README.md @@ -123,7 +123,7 @@ and used. If you want to use Eclipse to clone your fork, use the Eclipse Git Team Provider plugin -1. From the *File* menu, select *Import...* +1. From the Eclipse *File* menu, select *Import...* 2. From the *Git* folder, select *Projects from Git* and click *Next* 3. Select *Clone URI* to clone the remote repository. Click *Next*. + In the *Location* section, enter the URI of your fork in the *URI* field @@ -143,7 +143,7 @@ Once 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 -1. From the *File* menu, select *Import...* +1. From the Eclipse *File* menu, select *Import...* 2. From the *Maven* folder, select *Existing Maven Projects* and click *Next* + browse to the `samples` directory in the clone or source release directory and select it. A hierarchy of samples projects / pom.xml files will be @@ -160,8 +160,10 @@ Eclipse Maven or Git Team Provider. Once the samples projects have been imported you can run them from Eclipse in the usual manner. E.g., -1. open the `HelloEdgent.java` sample -2. click on *Run*, *Run As*, then *Java application*. +1. From the Eclipse *Navigate* menu, select *Open Type* + + enter type type name `HelloEdgent` and click *OK* +2. right click on the `HelloEdgent` class name and from the context menu + + click on *Run As*, then *Java application*. `HelloEdgent` runs and prints to the Console view.
