Skip to content

Commit

Permalink
Update README.md (#107)
Browse files Browse the repository at this point in the history
* Update README.md

While trying to use this library in a Gradle project, I was running into the error "Unable to access CRS file: proj4/nad/epsg". I noticed the note for Maven projects to add the epsg dependency, so tried adding it to my Gradle dependencies and it solved the problem.

* Update README.md

Make Gradle section similar to Maven section
  • Loading branch information
samuelcregan17 authored Dec 24, 2023
1 parent 49e04a0 commit 8f61332
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ where `{latest version}` refers to the version indicated by the badge above.

### Using Proj4J with Gradle

**!Important!** As of `1.2.2` version, `proj4-core` contains no EPSG Licensed files.
In order to make proj4j properly operate, it makes sense to consider `proj4-epsg` dependency usage.

To include Proj4J in a Gradle project, add a dependency block like the following:

```
Expand All @@ -57,6 +60,17 @@ dependencies {
```
where `{latest version}` refers to the version indicated by the badge above.

#### Proj4j EPSG

`Proj4J-EPSG` module distributes a portion of the EPSG dataset. This artifact is released the [EPSG database distribution license](https://raw.githubusercontent.com/locationtech/proj4j/master/LICENSE.EPSG).

To include `Proj4J-EPSG` in a Gradle project, add the following line to the dependency block:

```
implementation 'org.locationtech.proj4j:proj4j-epsg:{latest version}'
```
where `{latest version}` refers to the version indicated by the badge above.

### Basic Usage

The following examples give a quick intro on how to use Proj4J in common
Expand Down

0 comments on commit 8f61332

Please sign in to comment.