1. Improved Deployment and setup tasks in Rakefile

2. Improved README setup instructions

README.markdown

@@ -4,18 +4,32 @@
 4. **It's easy to use.** A collection of rake tasks simplifies development and makes deploying a cinch.
 5. **Get curated plugins.** Plugins are hand selected from the Jekyll community then tested and improved.
 
-## Get Setup
+## Getting Started
 
-[Fork Octopress](https://github.com/imathis/octopress), then open the console and follow along.
+[Create a new repository](https://github.com/repositories/new) for your website then
+open up a terminal and follow along. If you plan to host your site on [Github Pages](http://pages.github.com) for a user or organization, make sure the
+repository is named `your_username.github.com` or `your_organization.github.com`.
 
-    git clone (your repo url)
+### Setting up Git
 
-    # Optionally add a branch for pulling in Octopress updates
+    mkdir my_octopress_site
+    cd my_octopress_site
+    git init
     git remote add octopress git://github.com/imathis/octopress.git
+    git pull octopress master
+    git remote add origin (your repository url)
+    git push origin master
 
-Setup an [RVM](http://beginrescueend.com/) and install dependencies.
+    # If you're using Github user or organization pages,
+    # rename the master branch to source and then push
+    git branch -m master source
+    git push origin source
 
-    source .rvmrc
+
+### Setting up Octopress
+<span>Next</span>, setup an [RVM](http://beginrescueend.com/) and install dependencies.
+
+    rvm rvmrc trust
     bundle install
 
     # Install pygments (for syntax highlighing)
@@ -25,7 +39,23 @@ Setup an [RVM](http://beginrescueend.com/) and install dependencies.
     # Install the default Octopress theme
     rake install
 
-### Write A Post
+### Generating Your Blog
+
+    rake generate   # Generates your blog into the public directory
+    rake watch      # Watches files for changes and regenerates your blog
+    rake preview    # Watches, regenerates, and mounts a webserver at http://localhost:4000
+
+Jekyll's built in webbrick server is handy, but if you're a [POW](http://pow.cx) user, you can set it up to work with Octopress like this.
+
+    cd ~/.pow
+    ln -s /path/to/octopress
+    cd -
+
+Now you'll just run `rake watch` and load up `http://octopress.dev` instead.
+
+## Writing A Post
+
+While running `rake preview` or `rake watch`, open a new terminal session and start a Hello World post.
 
     rake post['hello world']
 
@@ -39,49 +69,58 @@ which tells Jekyll how to processes posts and pages.
     layout: post
     ---
 
-Octopress adds some custom paramaters to give you more publishing flexibility and you can [read about those here](#include_link),
+Now, go ahead and type up a sample post, or use some [inspired filler](http://baconipsum.com/). Save and refresh your browser, and you
-but for now. Go ahead and type up a sample post or use some [inspired filler](http://baconipsum.com/).
+should see the new post show up in your blog index.
 
-{% pullquote %}
+Octopress does more than this though. Check out [Blogging with Octopress](#include_link) to learn about cool features which
-  When writing longform posts, I find it helpful to include pullquotes, which help those scanning a post discern whether or not a post is helpful.
+help make blogging easier and more beautiful.
-  It is important to note, {" pullquotes are merely visual in presentation and should not appear twice in the text. "} That is why it is prefered
-  to use a CSS only technique for styling pullquotes.
-{% endpullquote %}
 
-## Generate Your Blog
+## Configuring Octopress
 
-    rake preview
+I've tried to keep configuring Octopress fairly simple. Here's a list of files for configuring Octopress.
 
-This will generate your blog, watch your `sass` and `source` directories for changes regenerating automatically, and mount Jekyll's built in webbrick server. Open your browser to `http://localhost:4000` and check it out.
+    _config.yml       # Main config (Jekyll blog settings)
+    Rakefile          # Config for Rsync deployment
+    config.rb         # Compass config
 
-If you'd rather use [POW](http://pow.cx) to serve up your site, you can do this instead.
+    sass/custom/_colors.scss      # change your blog's color scheme
+    sass/custom/_layout.scss      # change your blog's layout
+    sass/custom/_styles.scss      # override your blog's styles
 
-    cd ~/.pow
+Octopress keeps it's main configurations in two places, the `Rakefile` and the `_config.yml`. You probably won't have to change anything in the rakefile except the
-    ln -s /path/to/octopress
+deployment configurations (if you're going to [deploy with Rsync over SSH](#deploy_with_rsync)).
+
+## Deploying
+
+### Deploying with Rsync via SSH
 
-    #Then generate your site
+Add your server configurations to the `Rakefile` under Rsync deploy config. To deploy with Rsync, be sure your public key is listed in your server's `~/.ssh/authorized_keys` file.
-    rake watch
 
-`rake watch` does the same thing as `rake preview` except it doesn't mount Jekyll's webbrick server.
+    ssh_user      = "user@domain.com"
+    document_root = "~/website.com/"
 
-### Configure Octopress
+Now if you run `rake deploy` in your terminal, your `public` directory will be synced to your server's document root.
 
-Octopress keeps configurations in two places, the `Rakefile` and the `_config.yml`.
+### Deploying to Github Pages
 
-In the `rakefile` you'll want to set up your deployment configurations.
+To setup deployment, you'll want to clone your target repository into the `_deploy` directory in your Octopress project.
+If you're using Github project pages, clone the repository for that project, eg `git@github.com:username/project.git`.
+If you're using Github user or organization pages, clone the repository `git@github.com:usernem/username.github.com.git`.
 
-    ## -- Rsync Deploy config -- ##
+    # For Github project pages:
-    # Be sure your public key is listed in your server's ~/.ssh/authorized_keys file
+    git clone git@github.com:username/project.git _deploy
-    ssh_user      = "mathisweb@imathis.com"
+    rake init_deploy[gh-pages]
-    document_root = "~/dev.octopress.org/"
 
-    ## -- Git deploy config -- ##
+    # For Github user/organization pages:
-    source_branch = "source" # this compiles to your deploy branch
+    git clone git@github.com:username/username.github.com _deploy
-    deploy_branch = "master" # For user/organization pages, use "master" for project pages use "gh-pages"
+    rake init_deploy[master]
 
-If you want to deploy with github pages, read [http://pages.github.com](http://pages.github.com) for guidance.
+    # Now to deploy, you'll run
+    rake push
 
-TODO : Write _configt.yml instructions…
+The `init_deploy` rake task takes a branch name as an argument and creates a [new empty branch](http://book.git-scm.com/5_creating_new_empty_branches.html), adds an initial commit, and pushes it to the origin remote.
+This prepares your branch for easy deployment. The `rake push` task copies the generated blog from the `public` directory to the `_deploy` directory, adds new files, removes old files, sets a commit message, and pushes to Github.
+Then Github will queue your site for publishing (which usually occurs within minutes).
 
 ## License
 (The MIT License)

Rakefile

@@ -34,6 +34,12 @@ end
 # Working with Jekyll #
 #######################
 
+desc "Generate jekyll site"
+task :generate do
+  puts "## Generating Site with Jekyll"
+  system "jekyll"
+end
+
 desc "Watch the site and regenerate when it changes"
 task :watch do
   system "trap 'kill $jekyllPid $compassPid' Exit; jekyll --auto & jekyllPid=$!; compass watch & compassPid=$!; wait"
@@ -83,37 +89,14 @@ end
 # Deploying  #
 ##############
 
-## if you're deploying with github, change the default deploy to push_github
-desc "default push task"
-task :push => [:push_rsync] do
-end
-
-desc "Generate and deploy task"
-multitask :deploy => [:integrate, :generate, :push] do
-end
-
-desc "Generate jekyll site"
-task :generate do
-  puts "## Generating Site with Jekyll"
-  system "jekyll"
-end
-
-def ok_failed(condition)
-  if (condition)
-    puts "OK"
-  else
-    puts "FAILED"
-  end
-end
-
 desc "Deploy website via rsync"
-task :push_rsync do
+task :sync do
   puts "## Deploying website via Rsync"
   ok_failed system("rsync -avz --delete #{public_dir}/ #{ssh_user}:#{document_root}")
 end
 
 desc "deploy public directory to github pages"
-multitask :push_github do
+task :push do
   puts "## Deploying branch to Github Pages "
   (Dir["#{deploy_dir}/*"]).each { |f| rm_rf(f) }
   system "cp -R #{public_dir}/ #{deploy_dir}"
@@ -130,7 +113,26 @@ multitask :push_github do
   end
 end
 
+desc "setup _deploy folder and deploy branch"
+task :init_deploy, :branch do |t, args|
+  puts "Please provide a deploy branch, eg. rake init_deploy[gh-pages]" unless args.branch
+  cd "#{_deploy}" do
+    system "git symbolic-ref HEAD refs/heads/#{args.branch}"
+    system "rm .git/index"
+    system "git clean -fdx"
+    system "touch README && echo 'initial commit' >> README"
+    system "git add ."
+    system "git push origin #{args.branch}"
+  end
+end
 
+def ok_failed(condition)
+  if (condition)
+    puts "OK"
+  else
+    puts "FAILED"
+  end
+end
 
 desc "list tasks"
 task :list do