Browse files

Updates README, adds CONTRIBUTING.md

  • Loading branch information...
1 parent 730eba3 commit 1b8ccce0becbb2a582e984c8675544cb59bee681 Jeremy Kendall committed Sep 3, 2013
Showing with 58 additions and 7 deletions.
  1. +22 −0 CONTRIBUTING.md
  2. +36 −7 README.md
View
22 CONTRIBUTING.md
@@ -0,0 +1,22 @@
+# How to Contribute
+
+## Pull Requests
+
+1. Create your own [fork](https://help.github.com/articles/fork-a-repo) of the repo
+2. Create a new branch for each feature or improvement
+3. Send a pull request from each feature branch to the **develop** branch
+
+It is very important to separate new features or improvements into separate
+feature branches, and to send a pull request for each branch. This allows me to
+review and pull in new features or improvements individually.
+
+## Style Guide
+
+All pull requests must adhere to the [PSR-2 standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md).
+
+## Unit Testing
+
+All pull requests must be accompanied by passing unit tests and complete code
+coverage. The Slim Framework uses phpunit for testing.
+
+[Learn about PHPUnit](https://github.com/sebastianbergmann/phpunit/)
View
43 README.md
@@ -1,15 +1,43 @@
-Flaming Archer
-==============
+# Flaming Archer
master: [![Build Status](https://secure.travis-ci.org/jeremykendall/flaming-archer.png?branch=master)](https://travis-ci.org/jeremykendall/flaming-archer) develop: [![Build Status](https://secure.travis-ci.org/jeremykendall/flaming-archer.png?branch=develop)](https://travis-ci.org/jeremykendall/flaming-archer)
+## What is Flaming Archer?
+
+Flaming Archer is a "photo-a-day" application for hackers. It makes it simple to
+create a [365 day](http://fatmumslim.com.au/january-2013-photo-a-day-lets-do-this-thing/)
+[photo project](http://mylifescoop.com/2012/10/08/7-most-inspiring-365-day-photo-projects/) of your own.
+Simply [fork](https://help.github.com/articles/fork-a-repo) the project, deploy to
+your own server, run `composer install`, and voila! You're ready to rock.
+
+## Inspiration
+
Flaming Archer is a photo-a-day application I put together to learn the
[Slim PHP micro framework](http://www.slimframework.com/). The application has
-expanded to learning Puppet, rspec, Twig, and Composer, and I'm sure I'll find
-a way to stuff a lot more in there before I'm done.
+expanded to learning Puppet, rspec, Twig, and Composer, and more. It finally expanded
+to an application I thought was production ready, and now I'm using it to share
+[my own 365 day photo project](http://365.jeremykendall.net/).
+
+## Documentation
+
+Real documentation is on its way. Here's the quick and dirty.
-'Keeping it Small' Presentation
--------------------------------
+* Fork
+* Deploy to your server
+* Make sure your docroot is `/public`
+* `composer install`
+* Make sure `/db`, `/logs`, and `/tmp` are writeable by the web user
+* Edit the `$userConfig` portion of `/config.php` (only available after running `composer install`)
+* Visit http://your-project-site.com
+* Fill out the setup form
+* SUCCESS!
+
+## Contributing
+
+Pull requests and issues are welcome. Please review the CONTRIBUTING.md document
+before sending a PR.
+
+## 'Keeping it Small' Presentations
### TechCamp Memphis
@@ -18,7 +46,8 @@ micro framework* presentation, presented at [TechCamp Memphis](http://techcampme
on November 3, 2012. [Slides](http://www.slideshare.net/jeremykendall/keeping-it-small-slim-php)
and [video](http://www.youtube.com/watch?v=yEA0VWHCFac) are available.
-*The presentation was given on [revision 8f3d27b](https://github.com/jeremykendall/flaming-archer/tree/8f3d27b73159924102b607cbc0f4a005c971058e)*
+*The presentation was given on
+[revision 8f3d27b](https://github.com/jeremykendall/flaming-archer/tree/8f3d27b73159924102b607cbc0f4a005c971058e)*
### php[tek] 2013

0 comments on commit 1b8ccce

Please sign in to comment.