@@ -7,20 +7,36 @@ The Integration of the static analyzer [Goblint](https://github.com/goblint/anal
77
88## Installing
99
10- 1 . Install [ Goblint] ( https://github.com/goblint/analyzer#installing ) .
11- 2 . Download [ GobPie plugin] ( https://nightly.link/goblint/GobPie/workflows/build/master/gobpie-plugin.zip ) and unzip the archive.
12- 3 . Install the extension into VSCode with ` code --install-extension gobpie-0.0.5.vsix ` .
10+ ### Prerequisites
1311
14- When installing goblint locally (as recommended), ** make sure that GobPie can find the correct version of Goblint** .
12+ Make sure the following tools are installed:
13+
14+ - ** Java 17** (required to run GobPie)
15+ - Goblint (see its [ installation instructions] ( https://github.com/goblint/analyzer#installing ) )
16+ - VS Code
17+
18+ ### Install the GobPie extension
19+
20+ 1 . Download the [ GobPie plugin] ( https://nightly.link/goblint/GobPie/workflows/build/master/gobpie-plugin.zip ) .
21+ 2 . Unzip the archive.
22+ 3 . Install the extension into VSCode with:
23+
24+ ``` shell
25+ code --install-extension gobpie-0.0.5.vsix
26+ ```
27+
28+ ### Make GobPie find Goblint
29+
30+ If Goblint is installed locally (as recommended), ** make sure that GobPie can find the correct version of Goblint** .
1531This can be done in two ways:
1632
17- * Setting the location of the Goblint executable used by GobPie in ` gobpie.json ` :
33+ * ** Option 1: ** set the location of the Goblint executable used by GobPie in ` gobpie.json ` :
1834 ``` yaml
1935 " goblintExecutable " : " <installation path>/goblint"
2036 ` ` `
2137 The *installation path* is the path to your Goblint installation.
2238
23- * Activating the right opam switch before starting VS Code:
39+ * **Option 2:** activate the right opam switch before starting VS Code:
2440 ` ` ` shell
2541 eval $(opam env --switch=<switch name> --set-switch)
2642 code .
0 commit comments