Updated Contributor's Guide (markdown)
Typo correction; Code keyword hilighting
Fix typos. Change tabs to spaces.
Updating indenting preference
Updated Contributor's Guide (markdown)
Fixing some spacing issues
Updated Contributor's Guide (markdown)
Updated Contributor's Guide (markdown)
Fixing mis-matched tag issue
Updated Contributor's Guide
## Table of Contents
* [License](#slim-license)
* [Road Map](#slim-roadmap)
* [Issue Tracker](#slim-issue-tracker)
* [Learn PHPUnit](#learn-phpunit)
* [Learn PHPDoc](#learn-phpdoc)
* [Slim Organization](#slim-organization)
* [Contribute to Slim](#contribute-to-slim)
* [Code Documentation Guidelines](#slim-documentation-guidelines)
* [Code Testing Guidelines](#slim-testing-guidelines)
* [Code Style Guidlines](#slim-code-style-guidelines)
Read the License
Slim is licensed under the MIT License. You can read the license [here](http://slim.joshlockhart.com/license.txt).
[Back to Top](#slim-top)
Read the RoadMap
The GiHub Wiki contains the Slim Framework documentation and road map. Refer to the Road Map for a glimpse into Slim's short term and long term future. Road Map items in the near future will be added to the GitHub issue tracker.
[Visit the GitHub Wiki](http://github.com/codeguy/Slim/wiki)
[Back to Top](#slim-top)
Report and work on issues in the Issue Tracker
The GitHub issue tracker is the place to submit Slim Framework issues. This includes bugs, change requests, and feature requests. If your recommended changes are large enough, please open a new issue and post your proposal before writing and submitting code.
[Visit the GitHub Issue Tracker](http://github.com/codeguy/Slim/issues)
[Back to Top](#slim-top)
Learn PHPUnit
Slim development is backed by PHPUnit testing. I use PHPUnit as the official testing framework. For your code to be accepted into the Slim master repository, it must be **tested** and covered by PHPUnit tests.
[Learn more about PHPUnit](http://www.phpunit.de/)
[Back to Top](#slim-top)
Learn PHPDoc
Slim development is also actively documented. I use PHPDocumentor as the official inline code documentation. For your code to be accepted into the Slim master repository, it must be well documented using PHPDoc comments. I intend for Slim to be very well documented so that anyone can open the source code and find a friendly, easy to read explanation for every class, method, and variable.
[Learn more about PHPDocumentor](http://www.phpdoc.org/)
[Back to Top](#slim-top)
Slim Framework Organization
www/
.htaccess
bootstrap.php
slim/
templates/
The beauty of Slim is that it does not make any assumptions. You are free to re-arrange the default directory configuration as you need. The only requirements are:
1. The `bootstrap.php` and `.htaccess` files both reside in the same directory. This directory will be the Slim application's root directory, and it must exist beneath (or itself be) the document root directory.
2. All Slim class files are contained in the same directory. This enables the Slim Framework class loader to find the necessary class files.
### .htaccess
The `.htaccess` file must exist in the same directory as `bootstrap.php`. This directory can be the document root directory, or a sub-directory of the document root directory. The `.htaccess` file is responsible for implementing a Front Controller pattern, directing all HTTP requests to the `bootstrap.php` file.
### bootstrap.php
The `bootstrap.php` file is where the magic happens. This file contains your Slim application's routes and callbacks.
### slim/
The `slim/` directory contains all of the official Slim framework class files. If you move this directory elsewhere on your filesystem, ensure you keep the contents of this directory together. Do not add files to or remove files from this directory.
### templates/
Slim's default View class uses PHP templates that reside in this directory. If you use a custom View class (ie. for Twig or Smarty), then you will likely need to specify the templates and cache directory in your custom View class definition.
(markdown)
Adding back to top links
Updated Contributor's Guide (markdown)
Adding TOC
Updated Contributor's Guide (markdown)
Initial content
Created Contributor's Guide (markdown)