diff --git a/README.md b/README.md index e077acbeb2..6e59d4a237 100644 --- a/README.md +++ b/README.md @@ -18,12 +18,29 @@ This Jekyll theme was crafted with <3 by [John Otander](http://johnotander.com) If you're completely new to Jekyll, I recommend checking out the documentation at or there's a tutorial by [Smashing Magazine](http://www.smashingmagazine.com/2014/08/01/build-blog-jekyll-github-pages/). ``` -$ git clone git@github.com:johnotander/pixyll.git +$ git clone -o upstream git@github.com:johnotander/pixyll.git $ cd pixyll $ gem install bundler # If you don't have bundler installed $ bundle install ``` +Alternatively, if want to install the theme as a Gem, you can add this +line to your Gemfile: + +```ruby +gem "pixyll" +``` + +Then, add this line to your Jekyll site: + +```yaml +theme: pixyll +``` + +And then execute: + + $ bundle install + #### Verify your Jekyll version It's important to also check your version of Jekyll since this project uses Native Sass which @@ -33,6 +50,13 @@ is [only supported by 2.0+](http://jekyllrb.com/news/2014/05/06/jekyll-turns-2-0 Fork the repo, and then clone it so you've got the code locally. +If `git remote -v` doesn't have your fork listed, you can do the following to add it: + +``` +git remote add origin git@github.com:USER/pixyll.git +``` + +Where `USER` above is your GitHub user name. ### Modify the `_config.yml` @@ -68,6 +92,13 @@ Now you can navigate to `localhost:4000` in your browser to see the site. You can host your Jekyll site for free with Github Pages. [Click here](https://pages.github.com/) for more information. +If you are using the gem (see above), then you need to add the the +github-pages gem to your Gemfile: + +```ruby +gem 'github-pages' +``` + #### A configuration tweak if you're using a gh-pages sub-folder In addition to your github-username.github.io repo that maps to the root url, you can serve up sites by using a gh-pages branch for other repos so they're available at github-username.github.io/repo-name.