Skip to content

Commit 438c511

Browse files
authored
Merge pull request #792 from lonvia/gradle-fixes
Update README to mention gradle and disable distribution builds
2 parents 6732ccf + 3b6ef87 commit 438c511

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

README.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# photon
22

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

55
_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.
66

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

3434
### Installation
3535

36-
photon requires java, at least version 11.
36+
photon requires Java, at least version 11.
3737

3838
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).
3939
Now get the latest version of photon from [the releases](https://github.com/komoot/photon/releases).
@@ -48,12 +48,15 @@ wget -O - https://download1.graphhopper.com/public/photon-db-latest.tar.bz2 | pb
4848

4949
### Building
5050

51-
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:
51+
photon uses [gradle](https://gradle.org) for building. To build the package
52+
from source make sure you have a JDK installed. Then run:
5253

5354
```
54-
mvn package
55+
./gradlew build
5556
```
5657

58+
This will build and test photon. The final jar cn be found in `build/libs`.
59+
5760
### Usage
5861

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

6972
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.
7073

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

7376
```
7477
-h Show help / usage

build.gradle

+5
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ version = '0.5.0'
88

99
description = "Geocoder for OSM data"
1010

11+
distZip.enabled = false
12+
distTar.enabled = false
13+
shadowDistZip.enabled = false
14+
shadowDistTar.enabled = false
15+
1116
application {
1217
mainClass = 'de.komoot.photon.App';
1318
}

0 commit comments

Comments
 (0)