Update test-helper doc for the easiest installation instruction (#2744)

This commit is contained in:
Leedehai 2023-11-24 05:39:50 -05:00 committed by GitHub
parent 2b2bc62716
commit 07ae4fb923
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -14,6 +14,8 @@ 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`.
The simplest way to install this extension (and keep it up-to-date) is to use VSCode's UI:
* Go to View > Command Palette,
* In the drop down list, pick command "Developer: Install extension from location",
* Select this `test-helper` directory in the file explorer dialogue box. VSCode will add
the extension's path to `~/.vscode/extensions/extensions.json`.