diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 165c771..b14ecb5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,6 +10,22 @@ forms, such as: At all times the [code of conduct](#code-of-conduct) applies. +## Troubleshooting + +It's not completely trivial to configure Vimspector and there is a fairly large +amount of documentation. I know full well that documentation isn't everything, +so the first step in troubleshooting is to try a sample project that's known to +work, to check if the problem is your project configuration rather than an +actual bug. + +Therefore before raising an issue for a supported language, please check with +the sample projects in `support/test/` and `tests/testdata/` to see if +the problem is with your project settings, rather than with vimspector. + +Information on these is in [the README](README.md#trying-it-out). + +If in doubt, ask on Gitter. + ## Diagnostics Whenever reporting any type of fault, or difficulty in making the plugin diff --git a/README.md b/README.md index 40cf4d8..87b0e8f 100644 --- a/README.md +++ b/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 ``. + +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 diff --git a/make_package b/make_package index 2401fce..1b34a05 100755 --- a/make_package +++ b/make_package @@ -16,13 +16,20 @@ mkdir -p ${PACK} pushd ${PACK} mkdir -p vimspector/opt/vimspector pushd vimspector/opt/vimspector - for d in autoload plugin python3 vendor doc; do + for d in autoload plugin python3 vendor doc support; do if [[ -d ${ROOT}/$d ]]; then cp -r ${ROOT}/$d . fi done mkdir -p gadgets cp -r ${ROOT}/gadgets/${OS} gadgets/ + for f in install_gadget.py \ + CODE_OF_CONDUCT.md \ + CONTRIBUTING.md \ + LICENCE \ + README.md; do + cp ${ROOT}/${f} . + done popd popd