Skip to content

Commit

Permalink
Update dev notes in project readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisvogt committed Apr 24, 2015
1 parent ebb3483 commit ea23bbc
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,23 @@ This repository holds the [friendsofcake.com](http://friendsofcake.com) website

### Development Notes

#### Setup a local instance

This project is setup to use [Bundler](http://bundler.io/), [Jekyll](http://jekyllrb.com/), and [Bower](http://bower.io/). After cloning this repository, run:

1. `bundle install` to download dependencies required to build.
2. `bower install` to download front-end packages into the `./components` directory.
3. `jekyll serve` to run locally or `jekyll build` to generate into `./site` directory.

#### Development workflow

The workflow for contributing to this project is as follows:

1. Create a fork of the repository.
2. Base your feature branch on the `develop` repository.
3. Open a [new issue](https://github.com/FriendsOfCake/FriendsOfCake.github.io/issues) describing the bug, feature, or work you will be contributing.
3. Submit pull requests against the `develop` repository.

### Screenshot

![friendsofcake.com screenshot](http://i.imgur.com/7r6JKzP.gif)

0 comments on commit ea23bbc

Please sign in to comment.