32 lines
1.4 KiB
Text
32 lines
1.4 KiB
Text
|
# CakePHP DebugKit
|
||
|
|
|
||
|
|
DebugKit provides a debugging toolbar and enhanced debugging tools for CakePHP applications.
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
* Clone/Copy the files in this directory into `app/plugins/debug_kit`
|
||
|
|
* Include the toolbar component in your `app_controller.php`:
|
||
|
|
* `var $components = array('DebugKit.Toolbar');`
|
||
|
|
* Set debug mode to at least 1.
|
||
|
|
* 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.
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
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)
|
||
|
|
|
||
|
|
## Reporting issues
|
||
|
|
|
||
|
|
If you have an issues with DebugKit please open a ticket on lighthouse http://cakephp.lighthouseapp.com/projects/42880-debug-kit/overview
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
## Versions
|
||
|
|
|
||
|
|
DebugKit has several versions, they are compatible with different release of CakePHP.
|
||
|
|
|
||
|
|
* `1.0 -> 1.2` are compatible with CakePHP 1.2.x. These releases of DebugKit will not work with CakePHP 1.3.
|
||
|
|
* `1.3` is compatible with CakePHP 1.3.x only. It will not work with CakePHP 1.2.
|
||
|
|
|