diff options
| author | rsiddharth <rsiddharth@ninthfloor.org> | 2014-01-04 09:27:06 +0530 |
|---|---|---|
| committer | rsiddharth <rsiddharth@ninthfloor.org> | 2014-01-04 09:27:06 +0530 |
| commit | bfc25879fa8f1475ddebab1e5ebe2288c8760f97 (patch) | |
| tree | 48897e0215af7ca59d9b77a81d31dbd6e8914341 | |
| parent | ffd6c1d45d447385edf344be165af04d14749f4a (diff) | |
formatted text in README.
| -rw-r--r-- | README | 38 |
1 files changed, 20 insertions, 18 deletions
@@ -10,13 +10,14 @@ The subject and the body of the email is slurped from the commit message. `gitblag` is based on the `post-receive-email` script found in the -contrib/hooks directory in the [Git SCM][git]'s source. +contrib/hooks directory in the [Git SCM][git-source]'s source. [git]: http://git-scm.com/ +[git-source]: http://github.com/git/git -See 'Using gitblag' for info on how to install and use it. +See *using gitblag* for info on how to install and use it. -## Etymology +## etymology The name `gitblag` resulted from copulative compounding of two obvious word stems -- `git` & `blag`. @@ -26,7 +27,7 @@ in the [xkcd comic][blag]. [blag]: http://xkcd.com/148/ -## Using gitblag +## using gitblag `gitblag` is meant to be used as a post-receive hook on a bare remote git repository of a website/blog. This hook is invoked on the remote @@ -35,7 +36,7 @@ repository when a `git push` happens on the local repository. The `gitblag` script does two things: + Sends an email to the readers when it finds a specifically formatted - `commit` (See 'Commit Message Format' section), on the `master` + `commit` (see 'Commit Message Format' section), on the `master` branch. + Checks out the latest version of the working tree. @@ -45,7 +46,7 @@ Git to manage a web site][git-website]. [git-website]: http://toroid.org/ams/git-website-howto -### Installation +### installation Get a copy. @@ -63,37 +64,38 @@ Specify the location of the git maintained website/blog by changing the value of `GIT_WORK_TREE` variable in the `hooks/post-receive` script. -### Configuration +### configuration 1. Go to the remote bare git repo of the website/blog. - $ cd /path/to/your/bare/repo/wobsite.git + $ cd /path/to/your/bare/repo/wobsite.git 2. Set up the mailing list to which the script should send emails to. - $ git config --local --add hooks.mailinglist yourblag@list.tld + $ git config --local --add hooks.mailinglist yourblag@list.tld Or list the recipients' (the readers) email IDs, one email ID per line, in a plain text file and inform git about it. - $ git config --local --add hooks.recipientlist /path/to/readerlist.txt + $ git config --local --add hooks.recipientlist /path/to/readerlist.txt -3. Set up the email prefix. All emails will have their subjects prefixed -with this prefix, "[Mailing List Prefix]" if emailprefix is not set. +3. Set up the email prefix. All emails will have their subjects +prefixed with this prefix — `[Mailing List Prefix]` — if +emailprefix is not set. - $ git config --local --add hooks.emailprefix "[ BLAG PREFIX ]" + $ git config --local --add hooks.emailprefix "[ BLAG PREFIX ]" 4. Set up the mailing list footer. Edit the `description` file in the bare git repo. - $ editor description + $ editor description 5. To set a custom `From` field, the hooks.envelopesender option needs to be set. - $ git config --local --add hooks.envelopesender from@address.tld + $ git config --local --add hooks.envelopesender from@address.tld -### Commit Message Format +### commit message format + Start the commit message with `[NEW POST]` followed by text that will be used as the subject of the email. @@ -104,11 +106,11 @@ will be used as the subject of the email. See the `sample-commit-msg.txt` file. -## License +## license `gitblag` is licensed under the GNU General Public License version 3 or later. See COPYING for the full text of the license. -## Contact +## contact rsiddharth `<rsiddharth@ninthfloor.org>` |