summaryrefslogtreecommitdiff
path: root/plugins/vscode/README.md
diff options
context:
space:
mode:
authorAndy Pickle <39109475+pickleat@users.noreply.github.com>2020-02-24 13:13:16 -0600
committerGitHub <noreply@github.com>2020-02-24 20:13:16 +0100
commitf9a2d8cae39a0fb42e22aa17222c7da7b44b7ede (patch)
tree1cdd3469302cc31906ac368580ba1d304073f0f2 /plugins/vscode/README.md
parentbc9fe7423f5d8c639b208ebb9a7dbfce078bfd9b (diff)
downloadzsh-f9a2d8cae39a0fb42e22aa17222c7da7b44b7ede.tar.gz
zsh-f9a2d8cae39a0fb42e22aa17222c7da7b44b7ede.tar.bz2
zsh-f9a2d8cae39a0fb42e22aa17222c7da7b44b7ede.zip
vscode: add documentation for running in macOS (#8674)
Diffstat (limited to 'plugins/vscode/README.md')
-rw-r--r--plugins/vscode/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/plugins/vscode/README.md b/plugins/vscode/README.md
index 2c6530650..469c57ea8 100644
--- a/plugins/vscode/README.md
+++ b/plugins/vscode/README.md
@@ -8,6 +8,15 @@ To start using it, add the `vscode` plugin to your `plugins` array in `~/.zshrc`
plugins=(... vscode)
```
+## Requirements
+
+To use VS Code in the terminal **in macOS**, first you need to install the `code` command in the PATH,
+otherwise you might receive this message: `zsh: command not found: code`.
+
+[As the docs say](https://code.visualstudio.com/docs/setup/mac#_launching-from-the-command-line), open
+the Command Palette via (F1 or โ‡งโŒ˜P) and type shell command to find the Shell Command:
+> Install 'code' command in PATH
+
## VS Code Insiders
๐Ÿ **If you are only using [VS Code Insiders](https://code.visualstudio.com/insiders/), the plugin will automatically bind to your Insiders installation.**