Skip to content

Commit

Permalink
Explicit example of snapshot use, mentioning build server. (#488)
Browse files Browse the repository at this point in the history
  • Loading branch information
jodygarnett authored Jul 8, 2020
1 parent 3d37134 commit 6621f77
Showing 1 changed file with 32 additions and 9 deletions.
41 changes: 32 additions & 9 deletions USING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,11 @@

## Project Structure

JTS consists of several Java modules.
Each one corresponds to a separate JAR file.
JTS consists of several Java modules, each one corresponds to a separate JAR file.

The core modules are:

* `jts-core` - The JTS core: geometry model, operations, algorithms, and spatial data structures
* `jts-core` - geometry model, operations, algorithms, and spatial data structures
* `jts-io-common` - I/O classes for open spatial formats

The following modules depend on proprietary libraries, and are not built by default:
Expand All @@ -25,14 +24,21 @@ The following modules are applications and data for testing and working with JTS
To include JTS in a Maven project, add a dependency block like the following:

```xml
<properties>
<jts.version>1.16.1</jts.version>
</properties>
<dependency>
<groupId>org.locationtech.jts</groupId>
<artifactId>jts-core</artifactId>
<version>${jts.version}</version>
</dependency>
```

JTS snapshot artifacts are published to the LocationTech Maven repository. To include JTS in a project, add the following repositories to the pom.
JTS artifacts are available on maven central.

### Using JTS Snapshots

Our [build server](https://ci.eclipse.org/jts/) publishes to the LocationTech Maven repository. To include JTS in a project, add the following repositories to the pom:

```xml
<repositories>
Expand All @@ -55,11 +61,25 @@ JTS snapshot artifacts are published to the LocationTech Maven repository. To in
</repository>
</repositories>
```
## Using older versions of JTS with Maven

Older versions of JTS are available on Maven Central.
The latest snapshot builds are now avaialble:

```xml
<properties>
<jts.version>1.17.0-SNAPSHOT</jts.version>
</properties>
<dependency>
<groupId>org.locationtech.jts</groupId>
<artifactId>jts-core</artifactId>
<version>${jts.version}</version>
</dependency>
```

### Using prior versions of JTS with Maven

### 1.14
Older versions are available on Maven Central:

JTS 1.14.0:

```xml
<dependency>
Expand All @@ -73,7 +93,8 @@ Older versions of JTS are available on Maven Central.
<version>1.14.0</version>
</dependency>
```
### 1.13

JTS 1.13:

```xml
<dependency>
Expand All @@ -83,7 +104,9 @@ Older versions of JTS are available on Maven Central.
</dependency>
```

## Using JTS with Jigsaw
Prior releases can also be downloaded from [Source Forge](https://sourceforge.net/projects/jts-topo-suite/files/jts/).

## Using JTS with Jigsaw Modules

JTS uses [#ModuleNameInManifest](http://openjdk.java.net/projects/jigsaw/spec/issues/#ModuleNameInManifest) to export a module name for each of the JARs published for use as a library. In this way, you can depend on the various JTS modules in your `module-info.java` in the following way:

Expand Down

0 comments on commit 6621f77

Please sign in to comment.