X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/a7e7392d54753f52b44a207fec134bce931a5a06..f509fecc2eef88be0a7b88d491ae0c0ac13d686b:/doc/sdk/java-v2/index.html.textile.liquid diff --git a/doc/sdk/java-v2/index.html.textile.liquid b/doc/sdk/java-v2/index.html.textile.liquid index ee7e6cdb45..b3336d51df 100644 --- a/doc/sdk/java-v2/index.html.textile.liquid +++ b/doc/sdk/java-v2/index.html.textile.liquid @@ -10,13 +10,33 @@ Copyright (C) The Arvados Authors. All rights reserved. SPDX-License-Identifier: CC-BY-SA-3.0 {% endcomment %} -The Arvados Java SDK v2 provides a high level API for working with Arvados resources. It is packaged as a single JAR named -arvados-java-.jar, e.g. arvados-java-2.0.0.jar -which can be included in your project using Gradle, Maven, or by hand. +The Arvados Java SDK v2 provides a high level API for working with Arvados resources. h2. Using the SDK -FIXME - Add intro text here +The SDK is packaged as a JAR named @arvados-java-.jar@, which is published to Maven Central and can be included using Maven, Gradle, or by hand. + +Here is an example @build.gradle@ file that uses the Arvados java sdk: + +
+apply plugin: 'application'
+apply plugin: 'java-library'
+apply plugin: 'maven'
+
+repositories {
+    mavenCentral()
+}
+
+application {
+    mainClassName = "org.arvados.example.CollectionExample"
+}
+
+dependencies {
+    api 'org.arvados:arvados-java-sdk:0.1.0'
+}
+
+ +See "Java SDK Examples":example.html to get started using the SDK. h3. Logging @@ -111,17 +131,16 @@ See "Javadoc":javadoc.html h2. Building the Arvados SDK Dependencies: -* JDK for Java 8 or later https://www.oracle.com/technetwork/java/javase/downloads/index.html -* Gradle https://gradle.org/install/ +* JDK for Java 8 or later "https://www.oracle.com/technetwork/java/javase/downloads/index.html":https://www.oracle.com/technetwork/java/javase/downloads/index.html +* Gradle "https://gradle.org/install/":https://gradle.org/install/
-$ git clone https://github.com/curoverse/arvados.git
+$ git clone https://github.com/arvados/arvados.git
 $ cd arvados/sdk/java-v2
-$ ./gradlew test
-$ ./gradlew jar
+$ gradle test
+$ gradle jar
 
This will build the SDK and run all unit tests, then generate an Arvados Java sdk jar file in build/libs/arvados-java-2.0.0.jar
-