summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJon Cairns <jon@joncairns.com>2013-03-06 14:15:16 +0000
committerJon Cairns <jon@ggapps.co.uk>2013-03-06 14:15:16 +0000
commit11470b808797d8dcf3066644d24dec0f9cb1e20e (patch)
tree9463cda737179e4bb90e5664bab71d488b8d4546 /README.md
parent9b56c19aa5104a500db4acf823b446a02678d94b (diff)
downloadvdebug-11470b808797d8dcf3066644d24dec0f9cb1e20e.zip
Update version to 1.4.0
Updated HISTORY and README to reflect changes.
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 17 insertions, 4 deletions
diff --git a/README.md b/README.md
index 61aa84f..a672f48 100644
--- a/README.md
+++ b/README.md
@@ -16,11 +16,11 @@ It's written in Python, and has an object-oriented interface that is easy to ext
and can even be used from the command-line. It even has unit tests covering
some of the more critical parts of the code.
-# Recent version (version 1.3.2)
+# Recent version (version 1.4.0)
- * Use `:VdebugOpt <option>` to get the value of an option, and `:VdebugOpt <option> <value>` to set it.
- * Line breakpoints change position along with the Vim sign
- * Compatibility fixes for Python 2.6
+ * Allow setting of debugger features with the `g:vdebug_features` dictionary
+ * Stop error when trying to debug with an unsaved file
+ * Fixed stuck breakpoints
* And more... check out the HISTORY file
# How to use
@@ -99,6 +99,19 @@ To stop debugging, press `<F6>`. Press it again to close the debugger interface.
If you can't get a connection, then chances are you need to spend a bit of time setting up your environment. Type `:help Vdebug` for more information.
+# Debugging
+
+If you have a problem, and would like to see what's going on under the hood or raise an issue, it's best to create a log file. You can do this by setting these options before you start debugging:
+
+```vim
+:VdebugOpt debug_file ~/vdebug.log
+:VdebugOpt debug_file_level 2
+```
+
+Then start debugging, and you can follow what's added to the log file as you go. It shows the communication between the debugging engine and Vdebug.
+
+If you're creating an issue then it's probably best to upload a log as a Gist, as it can be pretty large.
+
# Contributing
I gladly accept contributions to the code. Just fork the repository, make your changes and open a pull request with detail about your changes. There are a couple of conditions: