From de08cdcd08fe6dc76a6b972519645b86a831dc82 Mon Sep 17 00:00:00 2001 From: Oliver Wipfli Date: Fri, 25 Feb 2022 09:18:36 +0100 Subject: [PATCH 1/3] Update adoptium links --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 25759abfe7..b1bfc351af 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,7 +3,7 @@ Pull requests are welcome! To set up your development environment: - Fork the repo -- [Install Java 16 or later](https://adoptium.net/installation.html) +- Install Java 16 or later. You can download Java manually from [Adoptium](https://adoptium.net/installation.html) or use their installers for [Windows](https://adoptium.net/installation.html#windows-msi), [macOS](https://adoptium.net/installation.html#macos-pkg), and [Linux](https://github.com/adoptium/website-v2/blob/main/src/asciidoc-pages/installation/linux.adoc). - Build and run the tests ([mvnw](https://github.com/takari/maven-wrapper) automatically downloads maven the first time you run it): - on max/linux: `./mvnw clean test` From dc7d3e12a067153f4f8195c1f0b5844ef8448d1e Mon Sep 17 00:00:00 2001 From: Oliver Wipfli Date: Fri, 25 Feb 2022 13:05:33 +0100 Subject: [PATCH 2/3] Crossref CONTRIBUTING.md --- README.md | 2 +- planetiler-examples/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4f485e794c..ab6a9dcf41 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ Style [© OpenMapTiles](https://www.openmaptiles.org/) To generate a map of an area using the [basemap profile](planetiler-basemap), you will need: -- [Java 16+](https://adoptium.net/installation.html) or [Docker](https://docs.docker.com/get-docker/) +- Java 16+ (see [CONTIRBUTING.md](CONTRIBUTING.md)) or [Docker](https://docs.docker.com/get-docker/) - at least 1GB of free disk space plus 5-10x the size of the `.osm.pbf` file - at least 1.5x as much free RAM as the input `.osm.pbf` file size diff --git a/planetiler-examples/README.md b/planetiler-examples/README.md index 2ce0b0c231..5c0e235331 100644 --- a/planetiler-examples/README.md +++ b/planetiler-examples/README.md @@ -4,7 +4,7 @@ This is a minimal example project that shows how to create custom maps with Plan Requirements: -- [Java 16 or later](https://adoptium.net/installation.html) +- Java 16+ (see [CONTIRBUTING.md](../CONTRIBUTING.md)) - on mac: `brew install --cask temurin` - [Maven](https://maven.apache.org/install.html) - on mac: `brew install maven` From c427775710888501ff03d20fe9155262c706dfcb Mon Sep 17 00:00:00 2001 From: Mike Barry Date: Fri, 4 Mar 2022 05:46:40 -0500 Subject: [PATCH 3/3] Add package manager snippets --- CONTRIBUTING.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b1bfc351af..61bbde1b1a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,7 +3,12 @@ Pull requests are welcome! To set up your development environment: - Fork the repo -- Install Java 16 or later. You can download Java manually from [Adoptium](https://adoptium.net/installation.html) or use their installers for [Windows](https://adoptium.net/installation.html#windows-msi), [macOS](https://adoptium.net/installation.html#macos-pkg), and [Linux](https://github.com/adoptium/website-v2/blob/main/src/asciidoc-pages/installation/linux.adoc). +- Install Java 16 or later. You can download Java manually from [Adoptium](https://adoptium.net/installation.html) or + use: + - [Windows installer](https://adoptium.net/installation.html#windows-msi) + - [macOS installer](https://adoptium.net/installation.html#macos-pkg) (or `brew install --cask temurin`) + - [Linux installer](https://github.com/adoptium/website-v2/blob/main/src/asciidoc-pages/installation/linux.adoc) + (or `apt-get install openjdk-17-jdk`) - Build and run the tests ([mvnw](https://github.com/takari/maven-wrapper) automatically downloads maven the first time you run it): - on max/linux: `./mvnw clean test`