summaryrefslogtreecommitdiff
path: root/tools
diff options
context:
space:
mode:
authorLaurenz <laurmaedje@gmail.com>2023-09-12 11:07:55 +0200
committerLaurenz <laurmaedje@gmail.com>2023-09-12 11:07:55 +0200
commit3ca4c94870b8ff5155369aa265e4123b62b94715 (patch)
tree1e2a94406c99c90f17b14af1ed9cc4b091f2f08e /tools
parentfa29c66a1190cf4b290e7430c4c1204d38e1650a (diff)
Explain how to install VS Code tools
Diffstat (limited to 'tools')
-rw-r--r--tools/support/README.md5
-rw-r--r--tools/test-helper/README.md5
2 files changed, 10 insertions, 0 deletions
diff --git a/tools/support/README.md b/tools/support/README.md
index c0efd090..72060bc6 100644
--- a/tools/support/README.md
+++ b/tools/support/README.md
@@ -6,3 +6,8 @@ autoclosing etc.
The extension was created for development purposes only. It is not maintained
and its grammar is not 100% accurate. For a more actively developed extension
see the third-party [Typst LSP](https://github.com/nvarner/typst-lsp).
+
+## Installation
+The simplest way to install this extension (and keep it up-to-date) is to add a
+symlink from `~/.vscode/extensions/typst-support` to
+`path/to/typst/tools/support`.
diff --git a/tools/test-helper/README.md b/tools/test-helper/README.md
index 45e0f6e2..c9226a23 100644
--- a/tools/test-helper/README.md
+++ b/tools/test-helper/README.md
@@ -12,3 +12,8 @@ the `tests` folder.
For the test helper to work correctly, you also need to install `oxipng`, for
example with `cargo install oxipng`.
+
+## Installation
+The simplest way to install this extension (and keep it up-to-date) is to add a
+symlink from `~/.vscode/extensions/typst-test-helper` to
+`path/to/typst/tools/test-helper`.