src/Tools/VSCode/extension/README.md
author wenzelm
Wed, 11 Jan 2017 16:11:39 +0100
changeset 64873 ee5aaf7bce0d
parent 64757 7e3924224769
child 64948 e655d965307c
permissions -rw-r--r--
more documentation;
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
7e3924224769 updated package;
wenzelm
parents: 64605
diff changeset
    13
  * `isabelle.home` points to the main Isabelle directory (ISABELLE_HOME).
7e3924224769 updated package;
wenzelm
parents: 64605
diff changeset
    14
  * `isabelle.cygwin_root` (on Windows) points to the Cygwin installation,
7e3924224769 updated package;
wenzelm
parents: 64605
diff changeset
    15
    e.g. ISABELLE_HOME/cygwin for a regular Isabelle application bundle.
64873
ee5aaf7bce0d more documentation;
wenzelm
parents: 64757
diff changeset
    16
ee5aaf7bce0d more documentation;
wenzelm
parents: 64757
diff changeset
    17
ee5aaf7bce0d more documentation;
wenzelm
parents: 64757
diff changeset
    18
## Isabelle symbols ##
ee5aaf7bce0d more documentation;
wenzelm
parents: 64757
diff changeset
    19
ee5aaf7bce0d more documentation;
wenzelm
parents: 64757
diff changeset
    20
Isabelle symbols like `\<forall>` may be rendered using the extension Prettify
ee5aaf7bce0d more documentation;
wenzelm
parents: 64757
diff changeset
    21
Symbols Mode. It needs to be configured manually as follows:
ee5aaf7bce0d more documentation;
wenzelm
parents: 64757
diff changeset
    22
ee5aaf7bce0d more documentation;
wenzelm
parents: 64757
diff changeset
    23
ISABELLE_HOME/src/Tools/VSCode/extension/isabelle-symbols.json contains a
ee5aaf7bce0d more documentation;
wenzelm
parents: 64757
diff changeset
    24
configuration (generated via `isabelle vscode_symbols`). Its content needs to
ee5aaf7bce0d more documentation;
wenzelm
parents: 64757
diff changeset
    25
be copied carefully into the regular VSCode User Preferences.