maximebf
diff --git a/‎build_archive.sh‎
Lines changed: 12 additions & 0 deletions b/‎build_archive.sh‎
Lines changed: 12 additions & 0 deletions
diff --git a/‎docs/error_log_debug.md‎
Lines changed: 36 additions & 0 deletions b/‎docs/error_log_debug.md‎
Lines changed: 36 additions & 0 deletions
diff --git a/‎docs/introduction.md‎
Lines changed: 11 additions & 0 deletions b/‎docs/introduction.md‎
Lines changed: 11 additions & 0 deletions
@@ -0,0 +1,12 @@
+#!/bin/bash
+
+TMPDIR=/tmp/atomik
+
+mkdir -p $TMPDIR
+
+(
+cd $TMPDIR
+composer create-project atomik/skeleton .
+)
+
+cd $(dirname $TMPDIR) && zip -r atomik.zip $(basename $TMPDIR)
@@ -79,3 +79,39 @@ Also, if *atomik.debug* is true, the error reporting level will be set to the ma
     Atomik::debug($myVar2); // no output
     Atomik::debug($myVar2, true); // use true to force the output even if debug set to false
 
+## Debug Bar
+
+Atomik provides a plugin to easily integrate [PHP DebugBar](http://phpdebugbar.com).
+The skeleton application comes with the debug bar thus you don't need to do the following steps.
+
+You'll need to install PHP Debug Bar by yourself. If you are using the skeleton, this
+can be done as follow:
+
+ - add the requirement in the *composer.json* file (`"maximebf/debugbar": "1.*"`)
+ - run `$ composer.phar update`
+
+Activate the plugin in the config and enable debug mode:
+
+    Atomik::add('plugins', 'DebugBar');
+    Atomik::set('atomik.debug', true);
+
+Render the debug bar in your layout:
+
+    <html>
+        <head>
+            ...
+            <?php if ($this['atomik.debug']) echo $this->renderDebugBarHead(); ?>
+        </head>
+        <body>
+            ...
+            <?php if ($this['atomik.debug']) echo $this->renderDebugBar(); ?>
+        </body>
+    </html>
+
+Be aware that the debug bar includes jQuery and FontAwesome. The debug bar needs
+at least jQuery to run properly. If you are using jQuery in your project, you can
+disable debug bar's own version using:
+
+    // this only includes FontAwesome
+    // set to false to include none of them
+    Atomik::set('plugins.DebugBar.include_vendors', 'css');
@@ -46,6 +46,17 @@ from [here](https://github.com/maximebf/atomik/releases).
 If you want to activate pretty URLs under Apache, rename the *htaccess.example* file
 to *.htaccess*.
 
+## About the skeleton
+
+Atomik Skeleton Application is a base Atomik application with a basic directory structure 
+which let you start building your project in a matter of seconds!
+
+It includes [Twitter Bootstrap](http://getbootstrap.com/), [jQuery](http://jquery.com) and
+[PHP DebugBar](http://phpdebugbar.com).
+
+The skeleton comes with debug mode activated. Don't forget to change *atomik.debug* to
+`false` in the config file when you switch to production mode.
+
 ## Directory structure
 
 Your application per se goes into the *app* directory. Actions and views have their own