diff --git a/README.md b/README.md index dc2a6ce..9acc53a 100644 --- a/README.md +++ b/README.md @@ -108,8 +108,11 @@ breakpoint. ## Watches -* Add watches to the variables window with -`:call vimspector#AddWatch( '' )` +The watches window is a prompt buffer. Enter insert mode to add a +new watch expression. + +* Add watches to the variables window by entering insert mode and + typing the expression. Commit with ``. * Expand result with ``. * Delete with ``. @@ -124,6 +127,17 @@ breakpoint. * The debugee prints to the stdout channel. * Other channels may be useful for debugging. +### Console + +The console window is a prompt buffer and can be used as an interactive +CLI for the debug adapter. Support for this varies amongt adapters. + +* Enter insert mode to enter a command to evaluate +* Commit the request with `` +* The request and subsequent result are printed. + +NOTE: See also [Watches][#watches] above. + # Supported Languages Current tested with the following debug adapters. @@ -316,6 +330,9 @@ Requires: - Vim 8.1 compiled with python 3 support. +Note the plugin uses a lot of very new Vim features (like prompt buffers), so +I would strongly recommend a very new build of Vim. + # FAQ 1. Q: Does it work? A: Yeah, sort of. It's _incredibly_ buggy and unpolished.