From 95f3a8429f6a55205f0927ae6ed5b7825ea2e8fd Mon Sep 17 00:00:00 2001 From: Benjamin Knofe Date: Wed, 28 Nov 2012 11:31:04 +0100 Subject: [PATCH] updated README.md --- README.md | 27 ++++++++------------------- 1 file changed, 8 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 25a4e1e..a5d2f97 100644 --- a/README.md +++ b/README.md @@ -58,42 +58,31 @@ Default is `false`. ### Step 4b - Git setup -First be sure that you have already placed your project under revision -control using git. - -For example, for the default values of remote="master" and -branch="gh-pages", the output of `git branch -a` should look like: - - gh-pages - * master - remotes/origin/HEAD -> origin/master - remotes/origin/gh-pages - remotes/origin/master - -This shows that "gh-pages" exists in the remote and local repos. There -needs to be at least one commit in "gh-pages" with which to start. - Edit `config.rb`, and add: activate :deploy do |deploy| deploy.method = :git end +With this default configuration, it will deploy to the "origin/gh-pages" branch of +your current repo. + #### These settings are optional. To use a particular remote, add: deploy.remote = "some-other-remote-name" -Default is `origin`. Run `git remote -v` to see a list of possible -remotes. +Default is `origin`. You can add a remote or a git url. +Run `git remote -v` to see a list of possible remotes or add a new one first. +If you specify a git url, be sure it ends with '.git'. To use a particular branch, add: deploy.branch = "some-other-branch-name" -Default is `gh-pages`. Run `git branch -a` to see a list of possible -branches. +Default is `gh-pages`. If the branch doesn't exist remote, it will be created +for you. ### Step 4c - FTP setup