[
https://issues.apache.org/jira/browse/EDGENT-364?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15824842#comment-15824842
]
ASF GitHub Bot commented on EDGENT-364:
---------------------------------------
Github user queeniema commented on a diff in the pull request:
https://github.com/apache/incubator-edgent-website/pull/90#discussion_r96332963
--- Diff: site/docs/edgent-getting-started.md ---
@@ -25,32 +25,43 @@ Edgent's primary API is functional where streams are
sourced, transformed, analy
### Downloading Apache Edgent
-To use Edgent you need the Edgent jars. You can either download the Edgent
source and build it or you can download a pre-built version of Edgent. See the
[download page]({{ site.data.project.download }}).
-
-After you have the Edgent jars, you can set up your environment.
+To use Edgent, you need the Edgent JAR files, which you may obtain by
completing the following steps.
+
+1. Locate the Edgent release you would like to use on the [downloads
page]({{ site.data.project.download }})
+2. In the Bundles column for the desired release:
+ * Click on the _Binary_ link if you simply want to use Edgent. This is
the easiest method is to get up and running as it contains a pre-built version
of Edgent.
+ * Click on the _Source_ link if you would like access to the Edgent
source files. If you choose this method, you must manually build Edgent
yourself.
+3. Download the .tgz file from one of the mirror sites
+4. Unpack the downloaded file: `tar zxvf
apache-edgent-X.X.X-incubating-XXX.tgz`
+5. Obtain the JARs
+ * If you are using a binary bundle, then the Java 8 JARs are located
in `edgent-X.X.X/java8`
+ * If you are using a source bundle, build the source code:
+ 1. Install [Gradle](https://gradle.org/) if it is not yet installed
+ 2. Navigate to the unpacked directory: `cd edgent-X.X.X-src`
+ 3. Run `gradle` to initialize the Gradle wrapper
+ 4. Build the code and Javadoc: `./gradlew assemble`
+ 5. The Java 8 JARs are located in
`edgent-X.X.X-src/build/distributions/java8`
### Setting up your environment
-Ensure that you are running a supported environment. For more information,
see the [Edgent overview](home). This guide assumes you're running Java 8.
-
-The Edgent Java 8 JAR files are located in the `edgent/java8/lib`
directory.
+Ensure that you are running a supported environment. For more information,
see the [Edgent overview](home). This guide assumes you're running Java 8. The
Edgent Java 8 JAR files are located in either the `edgent-X.X.X/java8` or
`edgent-X.X.X-src/build/distributions/java8` directory, depending on whether
you downloaded a binary or source bundle.
1. Create a new Java project in Eclipse, and specify Java 8 as the
execution environment JRE:
- <img src="images/New_Java_Project.JPG"
style="width:448px;height:589px;">
+ <img src="images/New_Java_Project.jpg">
-2. Modify the Java build path to include all of the JAR files in the
`edgent\java8\lib` directory:
+2. Add all of the JAR files in the `java8\lib` directory to the project's
build path:
--- End diff --
@dlaboss, I did not know about most of the things you mentioned! Thanks for
that Javadoc link. Adding just a provider JAR makes things super simple!
> Update instructions on how to use the binary/source release bundles
> -------------------------------------------------------------------
>
> Key: EDGENT-364
> URL: https://issues.apache.org/jira/browse/EDGENT-364
> Project: Edgent
> Issue Type: Improvement
> Components: Documentation, Web Site
> Reporter: Queenie Ma
> Assignee: Queenie Ma
> Priority: Minor
>
> I figure this information can be updated in the [Downloading Apache
> Edgent|http://edgent.incubator.apache.org/docs/edgent-getting-started.html#downloading-apache-edgent]
> section of the _Getting started_ page.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
