deac/middleman-deploy
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

updated README.md

Browse source
This commit is contained in:
Benjamin Knofe 2012-11-28 11:31:04 +01:00
parent 327a41fd05
commit 95f3a8429f
1 changed files with 8 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -58,42 +58,31 @@ Default is `false`.
### Step 4b - Git setup ### 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: Edit `config.rb`, and add:
activate :deploy do |deploy| activate :deploy do |deploy|
deploy.method = :git deploy.method = :git
end end
With this default configuration, it will deploy to the "origin/gh-pages" branch of
your current repo.
#### These settings are optional. #### These settings are optional.
To use a particular remote, add: To use a particular remote, add:
deploy.remote = "some-other-remote-name" deploy.remote = "some-other-remote-name"
Default is `origin`. Run `git remote -v` to see a list of possible Default is `origin`. You can add a remote or a git url.
remotes. 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: To use a particular branch, add:
deploy.branch = "some-other-branch-name" deploy.branch = "some-other-branch-name"
Default is `gh-pages`. Run `git branch -a` to see a list of possible Default is `gh-pages`. If the branch doesn't exist remote, it will be created
branches. for you.
### Step 4c - FTP setup ### Step 4c - FTP setup