summaryrefslogtreecommitdiffstats
path: root/gfx/wr/debugger/README.md
blob: d41b5ce16aa5a634ff8fba94df744cb7d589921e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# WebRender Debugger
A web based debugger for WebRender.

## Using the debugger
Build your application with the debugger feature enabled, for example in wrench:

```
cargo build --features=debugger
```

Now, open your browser and open the debugger/index.html file. Click Connect and
the debugger will attempt to connect to WR via websocket.

## Using the debugger with Gecko

In the Gecko source tree, open ```gfx/webrender_bindings/Cargo.toml``` in a text editor.

Add ```features = ['debugger']``` to the end of the file (in the ```dependencies.webrender``` section).

Vendor the rust dependencies locally for the debugger (we don't want these committed to the repo):
```./mach vendor rust```

Now, build and run as usual, and the debugger will be available.