src/Tools/VSCode/extension/README.md
changeset 66218 a30bf1c755c1
parent 66070 65a68dcd95c3
child 66221 e6b7edd12f05
equal deleted inserted replaced
66217:534ef013d169 66218:a30bf1c755c1
     2 
     2 
     3 This extension connects to the Isabelle Prover IDE infrastructure, using the
     3 This extension connects to the Isabelle Prover IDE infrastructure, using the
     4 VSCode Language Server protocol. This requires a recent development version of
     4 VSCode Language Server protocol. This requires a recent development version of
     5 Isabelle from 2017, see also:
     5 Isabelle from 2017, see also:
     6 
     6 
     7   * http://isabelle.in.tum.de/devel
     7   * <http://isabelle.in.tum.de/devel/release_snapshot>
     8   * http://isabelle.in.tum.de/repos/isabelle/file/tip/src/Tools/VSCode
     8   * <http://isabelle.in.tum.de/repos/isabelle/file/tip/src/Tools/VSCode>
     9 
     9 
    10 
    10 
    11 ## Important User Settings ##
    11 ## Prerequisites ##
       
    12 
       
    13 ### Important User Settings ###
    12 
    14 
    13   * On Linux and Mac OS X: `isabelle.home` points to the main Isabelle
    15   * On Linux and Mac OS X: `isabelle.home` points to the main Isabelle
    14     directory (`$ISABELLE_HOME`).
    16     directory (`$ISABELLE_HOME`).
    15 
    17 
    16   * On Windows: `isabelle.home` as above, but in Windows path notation with
    18   * On Windows: `isabelle.home` as above, but in Windows path notation with
    17     drive-letter and backslashes.
    19     drive-letter and backslashes.
    18 
    20 
    19 
    21 ### Support for Isabelle symbols ###
    20 ## Isabelle symbols ##
       
    21 
    22 
    22 Isabelle symbols like `\<forall>` are rendered using the extension "Prettify
    23 Isabelle symbols like `\<forall>` are rendered using the extension "Prettify
    23 Symbols Mode", which needs to be installed separately.
    24 Symbols Mode", which needs to be installed separately.
       
    25 
       
    26 In addition, the following user settings should be changed:
       
    27 
       
    28 ```
       
    29 "prettifySymbolsMode.substitutions": [
       
    30   {
       
    31     "language": "isabelle",
       
    32     "revealOn": "none",
       
    33     "adjustCursorMovement": true,
       
    34     "prettyCursor": "none",
       
    35     "substitutions": []
       
    36   },
       
    37   {
       
    38     "language": "isabelle-ml",
       
    39     "revealOn": "none",
       
    40     "adjustCursorMovement": true,
       
    41     "prettyCursor": "none",
       
    42     "substitutions": []
       
    43   }]
       
    44 ```
       
    45 
       
    46 
       
    47 ## Further Preferences ##
       
    48 
       
    49   * Preferred Color Theme: `Light+ (default light)`
       
    50 
       
    51   * Alternative Color Theme: `Dark+ (default dark)` – with restrictions: some color
       
    52     combinations don't work out properly
       
    53 
       
    54   * Recommended changes to default VSCode settings:
       
    55 
       
    56     ```
       
    57     "editor.acceptSuggestionOnEnter": false
       
    58     "editor.lineNumbers": "off"
       
    59     "editor.rulers": [100]
       
    60     "editor.wordBasedSuggestions": true
       
    61     ```