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

per recent updates

Browse source
This commit is contained in:
Tom Vaughan 2012-10-04 15:22:16 -03:00
parent 82a4915250
commit 54ebdd153e
2 changed files with 25 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -1,4 +1,4 @@
Middleman Delpoy -- Deploy a [middleman](http://middlemanapp.com/) built site over rsync or to github pages. Middleman Delpoy -- Deploy a [middleman](http://middlemanapp.com/) built site over rsync or via git (e.g. gh-pages on github).
[![Build Status](https://secure.travis-ci.org/tvaughan/middleman-deploy.png)](http://travis-ci.org/tvaughan/middleman-deploy) [![Build Status](https://secure.travis-ci.org/tvaughan/middleman-deploy.png)](http://travis-ci.org/tvaughan/middleman-deploy)
@ -6,8 +6,6 @@ Middleman Delpoy -- Deploy a [middleman](http://middlemanapp.com/) built site ov
## QUICK START ## QUICK START
If deploying through `rsync`, be sure it is installed.
### Step 1 ### Step 1
gem install middleman-deploy gem install middleman-deploy
@ -29,6 +27,8 @@ Then run:
### Step 4a - Rsync setup ### Step 4a - Rsync setup
First be sure that `rsync` is installed.
#### These settings are required. #### These settings are required.
Edit `config.rb`, and add: Edit `config.rb`, and add:
@ -56,7 +56,10 @@ To remove orphaned files or directories on the remote host, add:
Default is `false`. Default is `false`.
### Step 4b - GitHub Pages setup ### Step 4b - Git setup
First be sure that you have already placed your project under revision
control using git.
Edit `config.rb`, and add: Edit `config.rb`, and add:
@ -64,13 +67,26 @@ Edit `config.rb`, and add:
deploy.method = :git deploy.method = :git
end end
The git deploy method assumes your project is in a repository with #### These settings are optional.
github set up as `origin` and a working `gh-pages` branch already in place.
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.
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.
### Step 5 ### Step 5
middleman build [--clean] middleman build [--clean]
middleman deploy middleman deploy [--clean]
### NOTES ### NOTES

4
middleman-deploy.gemspec
View file

@ -9,8 +9,8 @@ Gem::Specification.new do |s|
s.authors = ["Tom Vaughan","Ben Cates"] s.authors = ["Tom Vaughan","Ben Cates"]
s.email = ["thomas.david.vaughan@gmail.com"] s.email = ["thomas.david.vaughan@gmail.com"]
s.homepage = "http://tvaughan.github.com/middleman-deploy/" s.homepage = "http://tvaughan.github.com/middleman-deploy/"
s.summary = %q{Deploy a middleman built site over rsync or to github pages.} s.summary = %q{Deploy a middleman built site over rsync or via git (e.g. gh-pages on github).}
s.description = %q{Deploy a middleman built site over rsync or to github pages.} s.description = %q{Deploy a middleman built site over rsync or via git (e.g. gh-pages on github).}
s.files = `git ls-files`.split("\n") s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n") s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")