You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 30, 2026. It is now read-only.
The easiest way to get started with Waterproof is to follow the steps:
16
+
The easiest way to get started with Waterproof on Linux or Mac is to follow the steps:
17
17
18
-
* Step 1. Install SerAPI following the steps below
18
+
* Step 1. Install SerAPI and coq-waterproof following the steps below
19
19
* Step 2. Install Waterproof using the installer from the [release page](http://github.com/impermeable/waterproof/releases)
20
20
21
21
### Step 1 for MacOS and Linux. Installation of SerAPI.
22
22
23
-
The following steps (1.a, 1.band 1.c) describe how to install SerAPI on MacOS or Linux.
23
+
The following steps (1.a, 1.b, 1.c and 1.d) describe how to install SerAPI and coq-waterproof on MacOS or Linux.
24
24
25
25
#### Step 1.a for MacOS and Linux: Install opam
26
26
27
27
##### On MacOS:
28
-
Install opam by running the following commands in the terminal (taken from https://opam.ocaml.org/doc/Install.html#OSX)
28
+
Install opam. You can either do so throug homebrew (https://brew.sh/) or through MacPorts (https://www.macports.org/). If you want to use homebrew, you can run the following commands in the terminal (taken from https://opam.ocaml.org/doc/Install.html#OSX)
29
29
```
30
30
brew install gpatch
31
31
brew install opam
32
32
```
33
33
34
+
If you prefer MacPorts, instead run
35
+
```
36
+
port install opam
37
+
```
38
+
34
39
##### On Linux:
35
40
Install opam, following instructions on https://opam.ocaml.org/doc/Install.html. For instance, for **Ubuntu**:
36
41
```
@@ -50,11 +55,6 @@ opam init
50
55
This may take a few minutes. In the meantime, opam will likely ask two questions. We recommend choosing 'y' to both, i.e. to opam modifying the `.bash_profile` and to opam adding a hook to the init scripts. Now execute the following line
51
56
```
52
57
eval `opam env`
53
-
```
54
-
55
-
##### On Linux or macOS:
56
-
Install OCaml with
57
-
```
58
58
opam switch create 4.11.1
59
59
eval `opam env`
60
60
```
@@ -75,9 +75,21 @@ Finally, execute again
75
75
eval `opam env`
76
76
```
77
77
78
+
#### Step 1.d for MacOS and Linux: Install the coq-waterproof library
79
+
80
+
Navigate in the terminal to a folder in which you are willing to place a folder with necessary library files. Then run:
### Step 2. Install Waterproof with the installer from the release page
79
91
80
-
After installing SerAPI, you are ready to install Waterproof using your preferred installer from the [release page](http://github.com/impermeable/waterproof/releases).
92
+
After installing SerAPI, you are ready to install Waterproof using your preferred installer from the [release page](http://github.com/impermeable/waterproof/releases). After installing Waterproof, it will ask you to point to a program called **sertop**. This is located in a hidden file folder. To show hidden file folders in the terminal press **⌘ + Shift + .** .
81
93
82
94
> **Known issue**: Because Waterproof is relatively unknown software, it is possible that it will initially be blocked by a virus scanner. To run Waterproof anyway: **on Windows:** Choose 'run anyway', **on Mac:** right-click and choose 'open software'; you may need to go to security settings to allow for running the app.
0 commit comments