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.

Sign up for GitHub

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

Jump to bottom

Fix build from source docs #1598

Merged
merged 3 commits into from
Apr 6, 2022
Merged

Fix build from source docs #1598

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1a501ff
Fix scala version
thpani Apr 6, 2022
1da4ae9
Reintroduce instructions to source shell env
thpani Apr 6, 2022
b16c63f
Fix punctuation
thpani Apr 6, 2022
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
6 changes: 4 additions & 2 deletions docs/src/apalache/installation/source.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,17 @@

1. Install `git`.
2. Install [OpenJDK8][] or [Zulu JDK8][].
thpani marked this conversation as resolved.
Show resolved Hide resolved
- 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)
- On Arch: `sudo pacman -Syu sbt`
- 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`
- To skip running the tests, you can run `make package`.
8. The distribution package will be built to `./target/universal/apalache-<VERSION>`, and you can
move this wherever you'd like, and ensure that the `<dist-package-location>/bin` directory
is added to your `PATH`.
Expand All @@ -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