summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLucas Hoffmann <l-m-h@web.de>2018-02-08 12:36:15 +0100
committerLucas Hoffmann <l-m-h@web.de>2018-02-08 12:48:57 +0100
commit81a1a6cdd5f637562b688d37879d51564acb9830 (patch)
tree1cfa2b6a922738f5fe8ad8bd36e66b4149067197 /README.md
parent1265239301a87ee220a0b1083a1b78f71c9d4350 (diff)
downloadvdebug-81a1a6cdd5f637562b688d37879d51564acb9830.zip
Reorder sections in README
Diffstat (limited to 'README.md')
-rw-r--r--README.md48
1 files changed, 23 insertions, 25 deletions
diff --git a/README.md b/README.md
index 7434307..53f14d9 100644
--- a/README.md
+++ b/README.md
@@ -18,30 +18,6 @@ It's written in Python, and has an object-oriented interface that is easy to
extend and can even be used from the command-line. It even has unit tests
covering some of the more critical parts of the code.
-## Getting help
-
-If you're having trouble with Vdebug in any way, here are the steps you can
-take to get help (in the right order):
-
-1. [Check the issues][3] to see whether it's already come up.
-2. Visit the **#vdebug** irc channel on freenode, someone is normally there.
-3. [Open a new issue.][4]
-
-## 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
-server debugging and more.
-
-To get this help, type:
-
-```
-:help Vdebug
-```
-
## Installation
**Requirements**:
@@ -62,7 +38,20 @@ The actual installation is no different than for any other Vim plugin, you can
file and update your plugins afterwards. For Vundle this would be `Plugin
'joonty/vdebug'` and `:PluginInstall`.
-## Quick guide
+## Usage
+
+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
+server debugging and more.
+
+To get this help, type:
+
+```
+:help Vdebug
+```
+
+### Quick guide
Set up any DBGP protocol debugger, e.g. Xdebug. (See :help VdebugSetUp). Start
Vdebug with `<F5>`, which will make it wait for an incoming connection. Run the
@@ -93,6 +82,15 @@ 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.
+## Getting help
+
+If you're having trouble with Vdebug in any way, here are the steps you can
+take to get help (in the right order):
+
+1. [Check the issues][3] to see whether it's already come up.
+2. Visit the **#vdebug** irc channel on freenode, someone is normally there.
+3. [Open a new issue.][4]
+
## Debugging
If you have a problem, and would like to see what's going on under the hood or