Clean-up documentation.
This commit is contained in:
parent
95a796ab41
commit
3876a2f986
2 changed files with 10 additions and 8 deletions
16
README.md
16
README.md
|
@ -64,8 +64,8 @@ Edit `config.rb`, and add:
|
||||||
deploy.method = :git
|
deploy.method = :git
|
||||||
end
|
end
|
||||||
|
|
||||||
With this default configuration, it will deploy to the "origin/gh-pages" branch of
|
By default this will deploy to the `gh-pages` branch on the `origin`
|
||||||
your current repo.
|
remote. The `build` directory will become a git repo.
|
||||||
|
|
||||||
#### These settings are optional.
|
#### These settings are optional.
|
||||||
|
|
||||||
|
@ -73,16 +73,18 @@ To use a particular remote, add:
|
||||||
|
|
||||||
deploy.remote = "some-other-remote-name"
|
deploy.remote = "some-other-remote-name"
|
||||||
|
|
||||||
Default is `origin`. You can add a remote or a git url.
|
Default is `origin`. This can be a remote name 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'.
|
If you use a remote name, you must first add it using `git remote
|
||||||
|
add`. Run `git remote -v` to see a list of possible remote names. If
|
||||||
|
you use a git url, it must end 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`. If the branch doesn't exist remote, it will be created
|
Default is `gh-pages`. This branch will be created on the remote if it
|
||||||
for you.
|
doesn't already exist.
|
||||||
|
|
||||||
### Step 4c - FTP setup
|
### Step 4c - FTP setup
|
||||||
|
|
||||||
|
|
2
THANKS
2
THANKS
|
@ -1,4 +1,4 @@
|
||||||
Ben Cates - Git deploy method.
|
Ben Cates - Git deploy method.
|
||||||
Gilbert Townshend - Bug reports and feature requests.
|
Gilbert Townshend - Bug reports and feature requests.
|
||||||
Konstantin Gribov -- Git deploy method improvements.
|
Konstantin Gribov -- Git deploy method improvements.
|
||||||
Benjamin Knofe -- FTP deploy method.
|
Benjamin Knofe -- FTP deploy method and Git improvements.
|
||||||
|
|
Loading…
Add table
Reference in a new issue