|
1 | 1 | #friendsofcake.com |
2 | 2 |
|
3 | | -[](https://travis-ci.org/chrisvogt/FriendsOfCake.github.io) [](https://codeclimate.com/github/chrisvogt/FriendsOfCake.github.io) []() <img src="https://cdn.rawgit.com/chrisvogt/FriendsOfCake.github.io/develop/img/FOC.png" alt="Friends Of Cake" width="280" align="right" /> |
| 3 | +[](https://travis-ci.org/chrisvogt/FriendsOfCake.github.io) |
| 4 | +[](https://codeclimate.com/github/chrisvogt/FriendsOfCake.github.io) |
| 5 | +[](https://github.com/FriendsOfCake/FriendsOfCake.github.io/blob/master/LICENSE) |
| 6 | +<img src="img/FOC.png" alt="Friends Of Cake" width="280" align="right"> |
4 | 7 |
|
5 | | -This repository holds the [friendsofcake.com](http://friendsofcake.com) website code, currently powered by [GitHub Pages](https://pages.github.com/) and [Jekyll](http://jekyllrb.com/). |
| 8 | +This repository holds the source code to the [friendsofcake.com](http://friendsofcake.com) website, a [Jekyll](http://jekyllrb.com/)-powered site hosted for free on [GitHub Pages](https://pages.github.com/). |
6 | 9 |
|
7 | 10 | ### Development Notes |
8 | 11 |
|
9 | | -#### Setup a local instance |
| 12 | +#### Setting up a local instance |
10 | 13 |
|
11 | | -This project is setup to use [Bundler](http://bundler.io/), [Jekyll](http://jekyllrb.com/), and [Bower](http://bower.io/). After cloning this repository, run: |
| 14 | +This project is setup to use [Bundler](http://bundler.io/), [Jekyll](http://jekyllrb.com/), and [Bower](http://bower.io/). |
| 15 | + |
| 16 | +After cloning this repository, run: |
12 | 17 |
|
13 | 18 | 1. `bundle install` to download dependencies required to build. |
14 | | -2. `bower install` to download front-end packages into the `./components` directory. |
| 19 | +2. `bower install` to download front-end packages into the `./components` directory. (This is not necessary for the `master` branch.) |
15 | 20 | 3. `jekyll serve` to run locally or `jekyll build` to generate into `./site` directory. |
16 | 21 |
|
17 | | -#### Development workflow |
18 | | - |
19 | | -The workflow for contributing to this project is as follows: |
20 | | - |
21 | | -1. Create a fork of the repository. |
22 | | -2. Base your feature branch on the `develop` repository. |
23 | | -3. Open a [new issue](https://github.com/FriendsOfCake/FriendsOfCake.github.io/issues) describing the bug, feature, or work you will be contributing. |
24 | | -3. Submit pull requests against the `develop` repository. |
25 | | - |
26 | 22 | ### Screenshot |
27 | 23 |
|
28 | | - |
| 24 | + |
29 | 25 |
|
30 | | -<img src="https://cdn.rawgit.com/jekyll/brand/master/jekyll-logo-light-transparent.png" alt="Made with Jekyll" width="140" align="right" /> <img src="http://bower.io/img/bower-logo.svg" alt="Made with Bower" height="70" align="right" /> |
| 26 | +<img src="https://cdn.rawgit.com/jekyll/brand/master/jekyll-logo-light-transparent.png" alt="Made with Jekyll" width="140" align="right" /> <img src="http://bower.io/img/bower-logo.svg" alt="Made with Bower" height="70" align="right"> |
0 commit comments