From 1a501ff9546079a28aa1fbb13e2ae584ebbc63e3 Mon Sep 17 00:00:00 2001 From: Thomas Pani Date: Wed, 6 Apr 2022 10:56:14 +0200 Subject: [PATCH 1/3] Fix scala version --- docs/src/apalache/installation/source.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/apalache/installation/source.md b/docs/src/apalache/installation/source.md index 8b717f82cc..a3d35b1820 100644 --- a/docs/src/apalache/installation/source.md +++ b/docs/src/apalache/installation/source.md @@ -2,7 +2,7 @@ 1. Install `git`. 2. Install [OpenJDK8][] or [Zulu JDK8][]. - - Apalache currently requires Scala 12.0 so **you must install version 8 of + - Apalache currently requires Scala 2.12.0 so **you must install version 8 of Java, otherwise Scala will not compile!** See the [compatibility table][]. 3. Install [sbt][]. - On Debian Linux or Ubuntu, [follow this guide](https://www.scala-sbt.org/1.x/docs/Installing-sbt-on-Linux.html#Ubuntu+and+other+Debian-based+distributions) From 1da4ae9a1f9beaf4282fd40c90fe548532b76253 Mon Sep 17 00:00:00 2001 From: Thomas Pani Date: Wed, 6 Apr 2022 10:58:49 +0200 Subject: [PATCH 2/3] Reintroduce instructions to source shell env These were probably unintentionally removed in 808f5388c9c5f3877d759e5176699d73cb0d1aa8 --- docs/src/apalache/installation/source.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/src/apalache/installation/source.md b/docs/src/apalache/installation/source.md index a3d35b1820..d0005a509c 100644 --- a/docs/src/apalache/installation/source.md +++ b/docs/src/apalache/installation/source.md @@ -10,6 +10,7 @@ - On macOS / Homebrew: `brew install sbt` 4. Clone the git repository: `git clone https://github.com/informalsystems/apalache.git`. 5. Change into the project directory: `cd apalache`. +6. Install [direnv][] and run `direnv allow`, or use [another way to set up the shell environment][shell environment]. 7. Run `make`. - To skip running the tests, you can run `make package` 8. The distribution package will be built to `./target/universal/apalache-`, and you can @@ -33,3 +34,4 @@ repository, you have three options after running `make`: [compatibility table]: https://docs.scala-lang.org/overviews/jdk-compatibility/overview.html [sbt]: https://www.scala-sbt.org/1.x/docs/Setup.html [direnv]: https://direnv.net/ +[shell environment]: https://github.com/informalsystems/apalache/blob/unstable/CONTRIBUTING.md#environment From b16c63fb080e11bbccd7b02c1dccfa3ec1492aa2 Mon Sep 17 00:00:00 2001 From: Thomas Pani Date: Wed, 6 Apr 2022 10:58:58 +0200 Subject: [PATCH 3/3] Fix punctuation --- docs/src/apalache/installation/source.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/apalache/installation/source.md b/docs/src/apalache/installation/source.md index d0005a509c..29fdc1ee47 100644 --- a/docs/src/apalache/installation/source.md +++ b/docs/src/apalache/installation/source.md @@ -12,7 +12,7 @@ 5. Change into the project directory: `cd apalache`. 6. Install [direnv][] and run `direnv allow`, or use [another way to set up the shell environment][shell environment]. 7. Run `make`. - - To skip running the tests, you can run `make package` + - To skip running the tests, you can run `make package`. 8. The distribution package will be built to `./target/universal/apalache-`, and you can move this wherever you'd like, and ensure that the `/bin` directory is added to your `PATH`.