Add troubleshooting guide
Also make sure that the gadget installer and other docs are included in the tarball installation.
This commit is contained in:
parent
c3105cf912
commit
980b80ebbb
3 changed files with 48 additions and 7 deletions
30
README.md
30
README.md
|
|
@ -255,12 +255,6 @@ packadd! vimspector
|
|||
|
||||
See support/doc/example_vimrc.vim.
|
||||
|
||||
Also, if you want to try out vimspector without changing your vim config, run:
|
||||
|
||||
```
|
||||
vim -Nu /path/to/vimspector/tests/vimrc --cmd "let g:vimspector_enable_mappings='HUMAN'"
|
||||
```
|
||||
|
||||
## Install some gadgets
|
||||
|
||||
There are a couple of ways of doing this, but ***using `install_gadget.py` is
|
||||
|
|
@ -380,6 +374,30 @@ Vimspector will also load any fies matching:
|
|||
format as `.gadgets.json` but are not overwritten when running
|
||||
`install_gadget.py`.
|
||||
|
||||
## Trying it out
|
||||
|
||||
If you just want to try out vimspector without changing your vim config, there
|
||||
are example projects for a number of languages in `support/test`, including:
|
||||
|
||||
* Python (`support/test/python/simple_python`)
|
||||
* Go (`support/test/go/hello_world`)
|
||||
* Nodejs (`support/test/node/simple`)
|
||||
* Chrome (`support/test/chrome/`)
|
||||
* etc.
|
||||
|
||||
To test one of these out, cd to the directory and run:
|
||||
|
||||
```
|
||||
vim -Nu /path/to/vimspector/tests/vimrc --cmd "let g:vimspector_enable_mappings='HUMAN'"
|
||||
```
|
||||
|
||||
Then press `<F5>`.
|
||||
|
||||
There's also a C++ project in `tests/testdata/cpp/simple/` with a `Makefile`
|
||||
which can be used to check everything is working. This is used by the regression
|
||||
tests in CI so should always work, and is a good way to check if the problem is
|
||||
your configuration rather than a bug.
|
||||
|
||||
# About
|
||||
|
||||
## Background
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue