src/Tools/VSCode/extension/README.md
author wenzelm
Fri, 10 Mar 2017 14:16:45 +0100
changeset 65172 365e97f009ed
parent 65138 64dfee6bd243
child 66070 65a68dcd95c3
permissions -rw-r--r--
default cygwin_root from Isabelle distribution;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
64757
7e3924224769 updated package;
wenzelm
parents: 64605
diff changeset
     1
# Isabelle Prover IDE support
7e3924224769 updated package;
wenzelm
parents: 64605
diff changeset
     2
7e3924224769 updated package;
wenzelm
parents: 64605
diff changeset
     3
This extension connects to the Isabelle Prover IDE infrastructure, using the
7e3924224769 updated package;
wenzelm
parents: 64605
diff changeset
     4
VSCode Language Server protocol. This requires a recent development version of
7e3924224769 updated package;
wenzelm
parents: 64605
diff changeset
     5
Isabelle from 2017, see also:
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
     6
64757
7e3924224769 updated package;
wenzelm
parents: 64605
diff changeset
     7
  * http://isabelle.in.tum.de/devel
7e3924224769 updated package;
wenzelm
parents: 64605
diff changeset
     8
  * http://isabelle.in.tum.de/repos/isabelle/file/tip/src/Tools/VSCode
7e3924224769 updated package;
wenzelm
parents: 64605
diff changeset
     9
64605
9c1173a7e4cb basic support for VSCode Language Server protocol;
wenzelm
parents:
diff changeset
    10
64757
7e3924224769 updated package;
wenzelm
parents: 64605
diff changeset
    11
## Important User Settings ##
7e3924224769 updated package;
wenzelm
parents: 64605
diff changeset
    12
64948
wenzelm
parents: 64873
diff changeset
    13
  * On Linux and Mac OS X: `isabelle.home` points to the main Isabelle
wenzelm
parents: 64873
diff changeset
    14
    directory (`$ISABELLE_HOME`).
wenzelm
parents: 64873
diff changeset
    15
wenzelm
parents: 64873
diff changeset
    16
  * On Windows: `isabelle.home` as above, but in Windows path notation with
wenzelm
parents: 64873
diff changeset
    17
    drive-letter and backslashes.
wenzelm
parents: 64873
diff changeset
    18
64873
ee5aaf7bce0d more documentation;
wenzelm
parents: 64757
diff changeset
    19
ee5aaf7bce0d more documentation;
wenzelm
parents: 64757
diff changeset
    20
## Isabelle symbols ##
ee5aaf7bce0d more documentation;
wenzelm
parents: 64757
diff changeset
    21
ee5aaf7bce0d more documentation;
wenzelm
parents: 64757
diff changeset
    22
Isabelle symbols like `\<forall>` may be rendered using the extension Prettify
ee5aaf7bce0d more documentation;
wenzelm
parents: 64757
diff changeset
    23
Symbols Mode. It needs to be configured manually as follows:
ee5aaf7bce0d more documentation;
wenzelm
parents: 64757
diff changeset
    24
64948
wenzelm
parents: 64873
diff changeset
    25
$ISABELLE_HOME/src/Tools/VSCode/extension/isabelle-symbols.json contains a
65138
64dfee6bd243 added admin tool "isabelle build_vscode";
wenzelm
parents: 64948
diff changeset
    26
configuration (generated via `isabelle build_vscode`). Its content needs to
64873
ee5aaf7bce0d more documentation;
wenzelm
parents: 64757
diff changeset
    27
be copied carefully into the regular VSCode User Preferences.