src/Tools/VSCode/extension/README.md
changeset 66218 a30bf1c755c1
parent 66070 65a68dcd95c3
child 66221 e6b7edd12f05
--- a/src/Tools/VSCode/extension/README.md	Thu Jun 29 17:37:03 2017 +0200
+++ b/src/Tools/VSCode/extension/README.md	Thu Jun 29 17:37:57 2017 +0200
@@ -4,11 +4,13 @@
 VSCode Language Server protocol. This requires a recent development version of
 Isabelle from 2017, see also:
 
-  * http://isabelle.in.tum.de/devel
-  * http://isabelle.in.tum.de/repos/isabelle/file/tip/src/Tools/VSCode
+  * <http://isabelle.in.tum.de/devel/release_snapshot>
+  * <http://isabelle.in.tum.de/repos/isabelle/file/tip/src/Tools/VSCode>
 
 
-## Important User Settings ##
+## Prerequisites ##
+
+### Important User Settings ###
 
   * On Linux and Mac OS X: `isabelle.home` points to the main Isabelle
     directory (`$ISABELLE_HOME`).
@@ -16,8 +18,44 @@
   * On Windows: `isabelle.home` as above, but in Windows path notation with
     drive-letter and backslashes.
 
-
-## Isabelle symbols ##
+### Support for Isabelle symbols ###
 
 Isabelle symbols like `\<forall>` are rendered using the extension "Prettify
 Symbols Mode", which needs to be installed separately.
+
+In addition, the following user settings should be changed:
+
+```
+"prettifySymbolsMode.substitutions": [
+  {
+    "language": "isabelle",
+    "revealOn": "none",
+    "adjustCursorMovement": true,
+    "prettyCursor": "none",
+    "substitutions": []
+  },
+  {
+    "language": "isabelle-ml",
+    "revealOn": "none",
+    "adjustCursorMovement": true,
+    "prettyCursor": "none",
+    "substitutions": []
+  }]
+```
+
+
+## Further Preferences ##
+
+  * Preferred Color Theme: `Light+ (default light)`
+
+  * Alternative Color Theme: `Dark+ (default dark)` – with restrictions: some color
+    combinations don't work out properly
+
+  * Recommended changes to default VSCode settings:
+
+    ```
+    "editor.acceptSuggestionOnEnter": false
+    "editor.lineNumbers": "off"
+    "editor.rulers": [100]
+    "editor.wordBasedSuggestions": true
+    ```