aboutsummaryrefslogtreecommitdiffstats
path: root/third_party/webrender/debugger/README.md
diff options
context:
space:
mode:
authorMukilan Thiyagarajan <mukilan@igalia.com>2023-09-14 15:00:42 +0530
committerMukilan Thiyagarajan <mukilan@igalia.com>2023-09-14 15:00:42 +0530
commitc385b3c9737c17d59cb02e520c3b68b232cb6497 (patch)
treead598ffbbdfbcecd6a4cf458abe2afc702d92c27 /third_party/webrender/debugger/README.md
parent988e05a68b48c9e744bf49459faf41a1bd9b81d7 (diff)
downloadservo-revert-webrender.tar.gz
servo-revert-webrender.zip
Revert "Upgrade WebRender to e491e1ae637b2eed1e7195855d88357e5eb3ddf9 (#30323)"revert-webrender
This reverts commit a9d37cb85ac2c55fc630fccffe1ba60ff00f555b.
Diffstat (limited to 'third_party/webrender/debugger/README.md')
-rw-r--r--third_party/webrender/debugger/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/third_party/webrender/debugger/README.md b/third_party/webrender/debugger/README.md
new file mode 100644
index 00000000000..d41b5ce16aa
--- /dev/null
+++ b/third_party/webrender/debugger/README.md
@@ -0,0 +1,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.