Skip to content

Commit 3d10bb1

Browse files
committed
Add installation instructions for jsdbg-gdb
1 parent 836c9c9 commit 3d10bb1

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

docs/README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ JsDbg is a tool that provides browser developers with a web-based platform for n
55

66
## Supported debuggers and platforms
77

8-
JsDbg currently supports WinDbg and the Visual Studio debugger on Windows. Support for additional debuggers (ex. GDB) and platforms (ex. MacOS) will be available in the future. If you wish to use JsDbg with a debugger that is currently unsupported, please file an issue (or upvote an existing one) to track your request.
8+
JsDbg currently supports WinDbg and the Visual Studio debugger on Windows, and GDB on Linux. Support for additional debuggers (ex. LLDB) and platforms (ex. MacOS) will be available in the future. If you wish to use JsDbg with a debugger that is currently unsupported, please file an issue (or upvote an existing one) to track your request.
99

1010
## JsDbg for WinDbg
1111

@@ -39,6 +39,43 @@ JsDbg currently supports WinDbg and the Visual Studio debugger on Windows. Suppo
3939

4040
4. The JsDbg server will launch and prompt you to select a browser. If the debugger is attached to one browser, it is recommended that you choose a different browser for JsDbg.
4141

42+
## JsDbg for GDB
43+
44+
### Setup (.deb package)
45+
46+
If using Debian or Ubuntu, you can install JsDbg as a .deb package:
47+
48+
1. Install the .NET Core Runtime using the instructions from [here](https://dotnet.microsoft.com/download).
49+
50+
2. Download [jsdbg-gdb.deb](https://aka.ms/jsdbg-gdb-deb).
51+
52+
3. Run `apt install ./jsdbg-gdb.deb`.
53+
54+
### Setup (.tar.bz2)
55+
56+
For other distributions, you can download a precompiled .tar.bz2. You do not
57+
need to install the .NET Core Runtime for this version.
58+
59+
1. Download [jsdbg-gdb.tar.bz2](https://aka.ms/jsdbg-gdb).
60+
61+
2. Extract the file somewhere, e.g. in your home directory: `cd ~ && tar xjf ~/Downloads/jsdbg-gdb.tar.bz2`
62+
63+
3. Add the following snippet to your `~/.gdbinit` file:
64+
65+
```
66+
python
67+
import sys
68+
sys.path.insert(0, "<path where you extracted the .tar.bz2>/jsdbg-gdb")
69+
import JsDbg
70+
end
71+
```
72+
73+
### Usage
74+
75+
1. Run GDB for your program as usual.
76+
77+
2. Type `jsdbg` at the GDB prompt to launch the server and open a browser window.
78+
4279
## Using JsDbg extensions
4380

4481
There are many different ways browser developers can incorporate JsDbg extensions into their debugging workflow. See [JsDbg features](FEATURES.md) for details about popular features in JsDbg.

0 commit comments

Comments
 (0)