From f34b5cea1a8486ceb13f66ce7abc0046b9241e87 Mon Sep 17 00:00:00 2001 From: Simon Parten Date: Tue, 1 Oct 2024 14:45:21 +0200 Subject: [PATCH 1/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 18737f53b..2f5ee5cea 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,6 +22,15 @@ Contents: * Binary Compatibility * Submitting a PR +Getting started +======= +Scala js dom currently targets java 17 for maximum compatibility. + +```sh +cs launch sbt --jvm 17 +``` +May would select a jvm that is known to work with the project + Packages ======== From fdf0347d57b13e9015f3ecf054394ce61395ea6c Mon Sep 17 00:00:00 2001 From: Simon Parten Date: Tue, 1 Oct 2024 14:45:43 +0200 Subject: [PATCH 2/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2f5ee5cea..1871cb182 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,7 +29,7 @@ Scala js dom currently targets java 17 for maximum compatibility. ```sh cs launch sbt --jvm 17 ``` -May would select a jvm that is known to work with the project +Would start sbt on a jvm that is known to work with the project Packages From 7b5364b8bbf25a1dd94441b3ddd07dca02a1b11f Mon Sep 17 00:00:00 2001 From: Simon Parten Date: Mon, 28 Oct 2024 20:43:50 +0100 Subject: [PATCH 3/3] More colour on coursier --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1871cb182..ce1e4a72e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,13 +24,14 @@ Contents: Getting started ======= -Scala js dom currently targets java 17 for maximum compatibility. +Scala js dom currently targets java 17 for maximum compatibility. If your shell is targeting a JVM higher than 17, you may experience confusing error messages when starting SBT. + +[Coursier](https://get-coursier.io/) is the de facto standard for artefact fetching in scala. Using coursier it is possible to launch SBT with a specific JVM version. The default [installation](https://get-coursier.io/docs/cli-installation) of coursier will put `cs` on your path, after which the following command (run in the root of the project) ```sh cs launch sbt --jvm 17 ``` -Would start sbt on a jvm that is known to work with the project - +will (if necessary download and) start sbt with temurin 17 - i.e. a jvm known to be compatible with the project. Packages ========