Permalink
Browse files

Write documents about git-todo

  • Loading branch information...
1 parent f4b0c71 commit 0d619024addb421a9b9ea11fce664727f598bd74 @pismute pismute committed Sep 2, 2012
Showing with 50 additions and 6 deletions.
  1. +50 −6 readme.md
View
@@ -1,17 +1,61 @@
-### tools
+## tools
* git-todo: A tool for branch summary
+ * git-ff: A fetching tool
+
+## git-todo
+
+`git-todo` list branches and tags with author, last commit message, SHA, distances from base branches. you can get a summary for your repository.
### Install
-Put `git-todo` in your excutable path then run:
+Put `git-todo` in your excutable path:
+
+ cd ~
+ git clone https://github.com/dogfeet/git-tles
+ echo "export PATH=~/bin:$PATH" >> ~/.bash_profile
+ mkdir ~/bin
+ cd ~/bin
+ ln -s ~/git-tles/git-todo git-todo
+
+### Run
+
+Usage is very simple. Just run:
+
+ git todo
+
+it show your local branches.
+
+![](http://dogfeet.github.com/articles/2012/git-todo/git-todo.png)
+
+* ![](http://dogfeet.github.com/articles/2012/git-todo/checkouted.png] means checkouted branch.
+* ![](http://dogfeet.github.com/articles/2012/git-todo/base_branch.png) is base branch(default - master).
+* ![](http://dogfeet.github.com/articles/2012/git-todo/ahead.png) is distance. `private-ko-build-ebook` branch has 3 commits base branch does not.
+* ![](http://dogfeet.github.com/articles/2012/git-todo/behind.png) is distance. `private-ko-build-ebook` branch does not have 23 commits base branch has.
+
+To change base branch to 'ko' branch, Add 'todo.base' config:
+
+ git config todo.base ko
+
+#### Options
+
+To include remote branches, Add `-r` option
+
+![](http://dogfeet.github.com/articles/2012/git-todo/git-todo-r.png)
+
+To include tags, Add '-t' option
+
+![](http://dogfeet.github.com/articles/2012/git-todo/git-todo-t.png)
+
+To include both of remote brnaches and tags, Add '-a' option
+
+![](http://dogfeet.github.com/articles/2012/git-todo/git-todo-a.png)
+
+## git-ff
- git todo
+It is a git helper like [git-up](https://github.com/aanand/git-up). I will write later.
-You can make your base branch:
- git config todo.base master2
-Otherwise `git todo` command use 'master' branch.

0 comments on commit 0d61902

Please sign in to comment.