diff options
author | Jon Cairns <jon@joncairns.com> | 2013-01-28 16:40:36 +0000 |
---|---|---|
committer | Jon Cairns <jon@ggapps.co.uk> | 2013-01-28 16:40:36 +0000 |
commit | 889cb85bc10aed57d21d62eb2a8e9aa4c4f975ed (patch) | |
tree | 8fa988b2c5744d6ac105da86b6eb79ef097c1a9d /README.md | |
parent | a576c352fb6c3b2ada671d9e8a2bac674f84a098 (diff) | |
download | vdebug-889cb85bc10aed57d21d62eb2a8e9aa4c4f975ed.zip |
Update README to mention latest version and changes
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 19 |
1 files changed, 19 insertions, 0 deletions
@@ -16,8 +16,17 @@ 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) + + * 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 + * And more... check out the HISTORY file + # How to use +First of all, scoot down to the quick guide below. + There is *extensive* help provided in the form of a Vim help file. This goes through absolutely everything, from installation to configuration, setting up debuggers for various languages, explanation of the interface, options, remote @@ -88,8 +97,18 @@ Once in debugging mode, the following default mappings are available: 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. + +# 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: + + * The tests must pass (run `python vdebugtests.py` in the top directory of the plugin) + * Your commit messages should follow the [rules outlined here][2] + # Licence This plugin is released under the [MIT License][1]. [1]: https://raw.github.com/joonty/vdebug/master/LICENCE +[2]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html |