issue #82 add breakpoint support

vscode-debugger/README.rst

@@ -12,3 +12,26 @@ to prevent Lua access to these.
 
 VSCode communicates with the adapter using a JSON wire protocol.
 
+Status
+------
+This is work in progress but the basic debugger is working with following features.
+
+* Launch a Ravi/Lua program and stop on entry
+* Step through code
+* Set breakpoints at line/source level
+
+Only source files that are available on disk can be debugged 
+Only tested on Windows 10 so far.
+
+Installation
+------------
+To install first build Ravi. 
+You should see a binary named `ravidebug.exe` built.
+
+Install the debugger extension as follows:
+
+1. Create a directory named `.vscode/extensions/dibyendumajumdar.ravi-debug-0.0.1/bin` under the home directory.
+2. Copy the `ravidebug` executable to the bin folder.
+3. Copy the file `vscode-debugger/vscode/extensions/dibyendumajumdar.ravi-debug-0.0.1/package.json` to the directory `.vscode/extensions/dibyendumajumdar.ravi-debug-0.0.1`.
+
+Now when you open a directory containing Lua programs VSCode should allow you to launch a debug session. You will need to change the launch parameters as required but note that right now `LUA_PATH` and `LUA_CPATH` are not passed on to the debugger.