From ad2d47e7160bcf326389de8358b781bbd19874aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Javier=20L=C3=B3pez?= Date: Fri, 19 Apr 2013 18:28:28 +0200 Subject: [PATCH] Improve readme --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index fe14fbb..3c730bf 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,13 @@ The procedure is the same as above, except: * Reload the debugger UI first, then reload the page you just modified. The line "Mobile device connected." should appear in the UI's output pane. * You should now be able to evaluate code remotely, set breakpoints, etc. +You can also preprocess your JS code to debug it offline: + +* Go to the config inside config folder (you can create a config.local.js file to override default config options). +* Enable the offline rewriter process setting `config.runOfflineRewriter = true` (you can disable the file server in this mode) +* Set the output folder where your debugging-enabled scripts will be placed, in the property `config.outputDir` +* In this mode, you can let Aardwolf to inject the debugging support script in your index file. You can do so by configuring `indexFile`, `whereToInsertAardwolf` and `aardwolfScript` properties in the config file. + Debugging processed or minified code ---------------------------------------------------------------------------------------------------- @@ -98,6 +105,13 @@ In most languages, making the modification should be pretty straightforward. PHP Now you should be ready to debug processed code. And since Aardwolf has access to the original files, its UI will display the original, unprocessed code for easier debugging. +Solving memory issues +---------------------------------------------------------------------------------------------------- + +In some cases in which there are many JavaScript files to debug, you could face a memory issue. If you find that the application is running slowly, you can use `white-list` and `black-list` config properties and choose only the javascript files you want to debug. +Using one of these properties, only the selected files will be processed by Aardwolf, improving application performance. + + How it works ----------------------------------------------------------------------------------------------------