From 0b0b931c21c3453aa988bcc5f8f3655dc27dd363 Mon Sep 17 00:00:00 2001 From: Michael Rose Date: Wed, 12 Feb 2014 09:30:09 -0500 Subject: [PATCH] Revise installation instructions Include Gemfile for Bundler install --- Gemfile | 9 ++++++ Gemfile.lock | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 15 +++++----- theme-setup.md | 14 +++++----- 4 files changed, 98 insertions(+), 14 deletions(-) create mode 100644 Gemfile create mode 100644 Gemfile.lock diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..b78bb06 --- /dev/null +++ b/Gemfile @@ -0,0 +1,9 @@ +source 'https://rubygems.org' + +gem 'jekyll' +gem 'kramdown' +gem 'coderay' +gem 'rake' +gem 'thor' +gem 'activesupport' +gem 'stringex' \ No newline at end of file diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000..a2aae30 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,74 @@ +GEM + remote: https://rubygems.org/ + specs: + activesupport (4.0.2) + i18n (~> 0.6, >= 0.6.4) + minitest (~> 4.2) + multi_json (~> 1.3) + thread_safe (~> 0.1) + tzinfo (~> 0.3.37) + atomic (1.1.14) + blankslate (2.1.2.4) + classifier (1.3.4) + fast-stemmer (>= 1.0.0) + coderay (1.1.0) + colorator (0.1) + commander (4.1.6) + highline (~> 1.6.11) + fast-stemmer (1.0.2) + ffi (1.9.3-x86-mingw32) + highline (1.6.20) + i18n (0.6.9) + jekyll (1.4.2) + classifier (~> 1.3) + colorator (~> 0.1) + commander (~> 4.1.3) + liquid (~> 2.5.5) + listen (~> 1.3) + maruku (~> 0.7.0) + pygments.rb (~> 0.5.0) + redcarpet (~> 2.3.0) + safe_yaml (~> 0.9.7) + toml (~> 0.1.0) + kramdown (1.3.1) + liquid (2.5.5) + listen (1.3.1) + rb-fsevent (>= 0.9.3) + rb-inotify (>= 0.9) + rb-kqueue (>= 0.2) + maruku (0.7.1) + minitest (4.7.5) + multi_json (1.8.4) + parslet (1.5.0) + blankslate (~> 2.0) + posix-spawn (0.3.8) + posix-spawn (~> 0.3.6) + yajl-ruby (~> 1.1.0) + rake (10.1.1) + rb-fsevent (0.9.4) + rb-inotify (0.9.3) + ffi (>= 0.5.0) + rb-kqueue (0.2.0) + ffi (>= 0.5.0) + redcarpet (2.3.0) + safe_yaml (0.9.7) + stringex (2.2.0) + thor (0.18.1) + thread_safe (0.1.3) + atomic + toml (0.1.0) + parslet (~> 1.5.0) + tzinfo (0.3.38) + yajl-ruby (1.1.0-x86-mingw32) + +PLATFORMS + x86-mingw32 + +DEPENDENCIES + activesupport + coderay + jekyll + kramdown + rake + stringex + thor diff --git a/README.md b/README.md index e8c8801..e7fc21d 100644 --- a/README.md +++ b/README.md @@ -28,16 +28,17 @@ General notes and suggestions for customizing **HPSTR**. ## Basic Setup for a new Jekyll site -1. [Install Jekyll](http://jekyllrb.com) and read through the documentation if you haven't already. -2. Fork the [HPSTR Jekyll THeme repo](https://github.com/mmistakes/hpstr-jekyll-theme/fork) -3. Clone the repo you just forked to your computer. +1. [Install Bundler](http://bundler.io) `gem install bundler` and then install [Jekyll](http://jekyllrb.com) and all dependencies `bundle install`. +2. Fork the [HPSTR Jekyll Theme repo](https://github.com/mmistakes/hpstr-jekyll-theme/fork). +3. Clone the repo you just forked and rename it. 4. Edit `_config.yml` to personalize your site. -5. Check out the sample posts in `_posts` to see examples for pulling in large feature images, tags, and other YAML data. -6. Read the documentation below for additional customization pointers and documentation. +5. Check out the sample posts in `_posts` to see examples for pulling in large feature images, assigning categories and tags, and other YAML data. +6. Read the documentation below for further customization pointers and documentation. -[Download the Theme](https://github.com/mmistakes/hpstr-jekyll-theme) +[Download the Theme](https://github.com/mmistakes/hpstr-jekyll-theme/archive/master.zip) -**Pro-tip:** Delete the `gh-pages` branch after cloning and start fresh by branching off `master`. There is a bunch of garbage in `gh-pages` used for the theme's demo that I'm guessing you don't want on your site. +**Pro-tip:** Delete the `gh-pages` branch after cloning and start fresh by branching off `master`. There is a bunch of garbage in `gh-pages` used for the theme's demo site that I'm guessing you don't want on your site. +{: .notice} --- diff --git a/theme-setup.md b/theme-setup.md index 1fb9858..52ff841 100644 --- a/theme-setup.md +++ b/theme-setup.md @@ -15,17 +15,17 @@ General notes and suggestions for customizing **HPSTR**. ## Basic Setup for a new Jekyll site -1. [Install Jekyll](http://jekyllrb.com) and read through the documentation if you haven't already. -2. Fork the [HPSTR Jekyll Theme repo](https://github.com/mmistakes/hpstr-jekyll-theme/fork) -3. Clone the repo you just forked to your computer. +1. [Install Bundler](http://bundler.io) `gem install bundler` and then install [Jekyll](http://jekyllrb.com) and all dependencies `bundle install`. +2. Fork the [HPSTR Jekyll Theme repo](https://github.com/mmistakes/hpstr-jekyll-theme/fork). +3. Clone the repo you just forked and rename it. 4. Edit `_config.yml` to personalize your site. -5. Check out the sample posts in `_posts` to see examples for pulling in large feature images, tags, and other YAML data. +5. Check out the sample posts in `_posts` to see examples for pulling in large feature images, assigning categories and tags, and other YAML data. 6. Read the documentation below for further customization pointers and documentation. -
Download the Theme
+
Download the Theme
-**Pro-tip:** Delete the `gh-pages` branch after cloning and start fresh by branching off `master`. There is a bunch of garbage in `gh-pages` used for the theme's demo that I'm guessing you don't want on your site. -{:.notice} +**Pro-tip:** Delete the `gh-pages` branch after cloning and start fresh by branching off `master`. There is a bunch of garbage in `gh-pages` used for the theme's demo site that I'm guessing you don't want on your site. +{: .notice} ---