Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README to mention gradle and disable distribution builds #792

Merged
merged 2 commits into from
Apr 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# photon

[![Continuous Integration](https://github.com/komoot/photon/workflows/Continuous%20Integration/badge.svg)](https://github.com/komoot/photon/actions)
[![Continuous Integration](https://github.com/komoot/photon/workflows/CI/badge.svg)](https://github.com/komoot/photon/actions)

_photon_ is an open source geocoder built for [OpenStreetMap](https://openstreetmap.org) data. It is based on [elasticsearch](http://elasticsearch.org/) - an efficient, powerful and highly scalable search platform.

Expand Down Expand Up @@ -33,7 +33,7 @@ photon software is open source and licensed under [Apache License, Version 2.0](

### Installation

photon requires java, at least version 11.
photon requires Java, at least version 11.

Download the search index (72G GB compressed, 159GB uncompressed as of 2023-10-26, worldwide coverage, languages: English, German, French and local name). The search index is updated weekly and thankfully provided by [GraphHopper](https://www.graphhopper.com/) with the support of [lonvia](https://github.com/lonvia).
Now get the latest version of photon from [the releases](https://github.com/komoot/photon/releases).
Expand All @@ -48,12 +48,15 @@ wget -O - https://download1.graphhopper.com/public/photon-db-latest.tar.bz2 | pb

### Building

photon uses [maven](https://maven.apache.org/) for building. To build the package from source make sure you have a JDK and maven installed. Then run:
photon uses [gradle](https://gradle.org) for building. To build the package
from source make sure you have a JDK installed. Then run:

```
mvn package
./gradlew build
```

This will build and test photon. The final jar cn be found in `build/libs`.

### Usage

Start photon with the following command:
Expand All @@ -68,7 +71,7 @@ Check the URL `http://localhost:2322/api?q=berlin` to see if photon is running w

To enable CORS (cross-site requests), use `-cors-any` to allow any origin or `-cors-origin` with a specific origin as the argument. By default, CORS support is disabled.

Discover more of photon's feature with its usage `java -jar photon-*.jar -h`. The available options are as follows:
Discover more of photon's featurse with its usage `java -jar photon-*.jar -h`. The available options are as follows:

```
-h Show help / usage
Expand Down
5 changes: 5 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ version = '0.5.0'

description = "Geocoder for OSM data"

distZip.enabled = false
distTar.enabled = false
shadowDistZip.enabled = false
shadowDistTar.enabled = false

application {
mainClass = 'de.komoot.photon.App';
}
Expand Down