diff --git a/README.md b/README.md index 9726810..4d9955a 100644 --- a/README.md +++ b/README.md @@ -139,6 +139,18 @@ environment variable: LD_LIBRARY_PATH="<...>/BUILD_native_dyn/INSTALL/lib/x86_64-linux-gnu" ``` +Debug a specific ZIM +--- + +`kiwix-desktop` uses **Qt WebEngine** to render ZIM content, relying on a custom `zim:` protocol to expose the ZIM data to the WebEngine. + +To debug issues related to WebEngine, follow these steps: + +1. Launch `kiwix-desktop` with the environment variable `QTWEBENGINE_REMOTE_DEBUGGING=` set (replace `` with an available local port number). +2. Open the desired ZIM file in the `kiwix-desktop` user interface. +3. In a Chromium-based browser, go to: `http://localhost:`. +4. This opens the remote debugging UI. Use it to access Chrome DevTools connected to the ZIM webpage rendered by WebEngine. + ## Communication Available communication channels: