Merge branch 'fixes' into main/rendor-staging
[ryzomcore.git] / web / public_php / webtt / plugins / debug_kit / README.mdown
blob10a386c7afc5cd03778bd0bb3aa41bbf553823e6
1 # CakePHP DebugKit
3 DebugKit provides a debugging toolbar and enhanced debugging tools for CakePHP applications.
5 ## Installation
7 * Clone/Copy the files in this directory into `app/plugins/debug_kit`
8 * Include the toolbar component in your `app_controller.php`:
9    * `var $components = array('DebugKit.Toolbar');`
10 * Set debug mode to at least 1.
11 * Make sure to remove the 'sql_dump' element from your layout if you want to experience the awesome that is the debug kit SQL log.
13 ## Documentation
15 Further documentation including additional configuration and ways of extending DebugKit can be found in the [Lighthouse wiki](http://cakephp.lighthouseapp.com/projects/42880-debug-kit/overview)
17 ## Reporting issues
19 If you have an issues with DebugKit please open a ticket on lighthouse http://cakephp.lighthouseapp.com/projects/42880-debug-kit/overview
21 ## Contributing
23 If you'd like to contribute to DebugKit, check out the [Roadmap](http://cakephp.lighthouseapp.com/projects/42880/roadmap) for any planned features.  You can fork the project add features and send pull requests, or open tickets on lighthouse.
25 ## Versions
27 DebugKit has several versions, they are compatible with different release of CakePHP.
29 * `1.0 -> 1.2` are compatible with CakePHP 1.2.x.  These releases of DebugKit will not work with CakePHP 1.3.
30 * `1.3` is compatible with CakePHP 1.3.x only.  It will not work with CakePHP 1.2.