Skip to content

Commit 8103b6a

Browse files
committed
edits
1 parent 7c73381 commit 8103b6a

1 file changed

Lines changed: 17 additions & 22 deletions

File tree

README.md

Lines changed: 17 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -24,31 +24,26 @@ Here's what you need to get going with the Splunk SDK for Java.
2424
* Splunk
2525

2626
If you haven't already installed Splunk, download it [here](http://www.splunk.com/download).
27-
For more information, see the Splunk Enterprise [Installation Manual](https://docs.splunk.com/Documentation/Splunk/latest/Installation).
27+
For more information, see the Splunk Enterprise [_Installation Manual_](https://docs.splunk.com/Documentation/Splunk/latest/Installation).
2828

2929
* Splunk SDK for Java
3030

31-
Get the JAR from the [Splunk Developer Portal](https://dev.splunk.com/enterprise/downloads/) or clone the repository from [GitHub](https://github.com/splunk/splunk-sdk-java) if you want to contribute to the SDK. To use Maven, see "Use Maven" "below.
31+
Get the JAR from the [Splunk Developer Portal](https://dev.splunk.com/enterprise/downloads/) or clone the repository from [GitHub](https://github.com/splunk/splunk-sdk-java) if you want to contribute to the SDK. To use Maven, see "Use Maven" below.
3232

33-
* Java and Ant
34-
35-
You'll need:
36-
37-
* Java version 6 or higher, from [OpenJDK](https://openjdk.java.net) or [Oracle](https://www.oracle.com/technetwork/java).
38-
* Ant, which you can install from the [Apache website](http://ant.apache.org/bindownload.cgi).
39-
40-
The Splunk SDK for Java is compatible with Java 8. Be aware that **Java 8 disables Secure Sockets Layer version 3 (SSLv3) by default**, so you will need to use Transport Layer Security (TLS) instead. To see an example of how to do this, see the [ssl_protocols](https://github.com/splunk/splunk-sdk-java/blob/master/examples/com/splunk/examples/ssl_protocols/Pro...) example. Alternatively, you can re-enable SSLv3 in Java settings, but this is not recommended.
41-
42-
If you are using Windows, you'll need to make sure the following system variables are created and set:
43-
* **ANT_HOME** should be set to the location where Ant is installed.
44-
* **JAVA_HOME** should be set to the directory where the JDK is installed.
45-
* **PATH** should include the path to the **%ANT_HOME%\bin** directory.
46-
47-
For installation instructions, see:
48-
* [Java Platform Installation](http://www.oracle.com/technetwork/java/javase/index-137561.html)
49-
* [Installing Apache Ant](http://ant.apache.org/manual/install.html)
50-
51-
* Maven (optional)
33+
* Java version 6 or higher, from [OpenJDK](https://openjdk.java.net) or [Oracle](https://www.oracle.com/technetwork/java). For instructions, see [Java Platform Installation](http://www.oracle.com/technetwork/java/javase/index-137561.html) on the Oracle website.
34+
35+
The Splunk SDK for Java is compatible with Java 8. Be aware that **Java 8 disables Secure Sockets Layer version 3 (SSLv3) by default**, so you will need to use Transport Layer Security (TLS) instead. To see an example of how to do this, see the [ssl_protocols](https://github.com/splunk/splunk-sdk-java/blob/master/examples/com/splunk/examples/ssl_protocols/Pro...) example. Alternatively, you can re-enable SSLv3 in Java settings, although this is not recommended.
36+
37+
* Ant, which you can install from the [Apache website](http://ant.apache.org/bindownload.cgi). For instructions, see [Installing Apache Ant](http://ant.apache.org/manual/install.html).
38+
39+
### Set system variables (Windows)
40+
41+
If you are using Windows, make sure the following system variables are created and set:
42+
* **ANT_HOME** should be set to the location where Ant is installed.
43+
* **JAVA_HOME** should be set to the directory where the JDK is installed.
44+
* **PATH** should include the path to the **%ANT_HOME%\bin** directory.
45+
46+
### Use Maven to build projects
5247

5348
You can use [Apache Maven](http://maven.apache.org/) to build your Splunk SDK for Java projects with a few updates to your project's **pom.xml** file. You can retrieve all necessary dependencies and build your project.
5449

@@ -82,7 +77,7 @@ Here's what you need to get going with the Splunk SDK for Java.
8277

8378
> **Note**: You can make similar changes to use [Ivy](http://ant.apache.org/ivy/history/latest-milestone/tutorial/start.html) or [Gradle](http://www.gradle.org/) as well.
8479

85-
### Build the SDK and documentation
80+
### Use ant to build the SDK and documentation
8681

8782
To build the SDK, open a command prompt in the **/splunk-sdk-java** directory and enter:
8883

0 commit comments

Comments
 (0)