Update README.rst

pull/85/head
Dibyendu Majumdar 8 years ago
parent b5b909ee1a
commit a74b025b83

@ -7,9 +7,8 @@ Lua code.
Implementation Notes
--------------------
The approach is to create a standalone executable that can be invoked by VSCode. VSCode communicates
with the adapter via stdin/stdout. This means that Lua cannot use stdin/stdout - but for now nothing is done
to prevent Lua access to these. Eventually any Lua output to stdout/stderr will be captured and sent
to the debugger front-end.
with the adapter via stdin/stdout. This means that Lua cannot use stdin/stdout therefore Lua output
to stdout/stderr is captured and sent to the debugger front-end.
VSCode communicates with the adapter using a JSON wire protocol. For a sample session look at
`Example JSON Protocol Messages <https://github.com/dibyendumajumdar/ravi/blob/master/vscode-debugger/docs/example-protocol-messages.txt>`_.
@ -35,16 +34,7 @@ Note: This is very early days and the debugger not yet ready for real use so try
Installation
------------
To install first build Ravi.
You should see an executable named `ravidebug` in the build directory.
Install the debugger extension as follows:
1. Create a directory named `.vscode/extensions/dibyendumajumdar.ravi-debug-0.0.1/bin` under the home directory. On Windows 10 this is under /Users/<username>.
2. Copy the `ravidebug` executable to the bin folder created above.
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.
Currently a Windows 10 64-version is available from the Visual Studio Code marketplace - just search for extension 'Ravi Debug'.
Screenshots
-----------

Loading…
Cancel
Save