aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 2eb5fc5940fa8354e9cf05590f09e21fd5f6cabb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
git-todo
========

Output TODO lines since `master` or a specified ref.


## Example

	$ git todo b0aa9334017e433225175d323732472c35f51aed
	src/lib.rs:38:                            if l.contains("TODO") {
	src/main.rs:38:        // TODO: error if more than one ref given


## Install
On Mac OS X, Git-Todo can be installed with Homebrew:

	$ brew install teddywing/formulae/git-todo

To compile from source or install on other platforms:

	$ cargo install --git https://github.com/teddywing/git-todo.git


## Uninstall

	$ cargo uninstall git-todo


## Vim plugin
A Vim plugin is available to facilitate TODO navigation:
https://github.com/teddywing/vim-git-todo


## License
Copyright © 2020 Teddy Wing. Licensed under the GNU GPLv3+ (see the included
COPYING file).