Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added some basic documentation/gh-pages
- Loading branch information
Showing
9 changed files
with
178 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,4 +3,6 @@ | |
.gitignore | ||
.todo | ||
.todoignore | ||
docs | ||
res | ||
test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# Find | ||
|
||
__The power of todo's find command is what really makes todo shine. Find any | ||
given task in a matter of seconds and even where to start coding it.__ | ||
|
||
|
||
*** | ||
|
||
|
||
### @Assignee | ||
|
||
The "@"-symbol is for assignee. Prefix your name with "@" and you'll get a list | ||
of tasks sorted by date-added that you are suppose to do. | ||
|
||
t find "@$(whoami)" | ||
|
||
Tasks that are not assigned to anyone specific will land under the assignee | ||
@none. This means you can easily manage a taskpool by just querying: | ||
|
||
t find "@none" | ||
|
||
You can also use the alias @unassigned | ||
|
||
|
||
*** | ||
|
||
|
||
### Labels | ||
|
||
Labels come in two forms. The keyword that the task was prefixed with | ||
(TODO | OPTIMIZE | BUG | FIXME) and words starting with a hash-symbol. The | ||
latter can also have brackets that store a numeric value. This numeric value | ||
can be filtered and sorted upon. | ||
|
||
t find "#pri[>3]*" | ||
|
||
In the example above I have suffixed the label with an asterix, that selects | ||
the label for sorting. This is usefull in conjunction with the --reverse flag | ||
for ascending sorts. You can also see that there is filtering being done using | ||
brackets, so labels with a numeric value of less than three will not be shown. | ||
|
||
t find "#pri[3]" | ||
|
||
This would effectively be the same as querying #pri[==3] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# Todo | ||
|
||
__Taskmanagement, your way!__ | ||
|
||
|
||
For decades people have put todo's into their sourcecode, but usually they get | ||
left behind and forgotten about. Todo not only shines new light on these old | ||
bits, but it makes it easy to manage them and use them as real issue-tracking. | ||
|
||
|
||
*** | ||
|
||
|
||
### Usage: t [options] [command] | ||
|
||
#### Commands: | ||
|
||
init [path] | ||
|
||
update [path] | ||
|
||
find <query> | ||
|
||
gui [path] [port] | ||
|
||
#### Options: | ||
|
||
-h, --help output usage information | ||
-v, --version output the version number | ||
-l, --limit <n> Limit the results output | ||
-r, --reverse Reverse the sort-order | ||
-c, --count Supress normal output. Output number of tasks instead | ||
|
||
-b, --body Output the body of each task | ||
-i, --id Ouput the id of each task | ||
|
||
-N, --no-line Supress output of line-numbers. | ||
-H, --no-filename Supress output of filenames. | ||
-C, --no-color Prevent colored output | ||
-G, --no-group Prevent grouping by filename | ||
|
||
-q, --quiet Will run without output | ||
|
||
|
||
*** | ||
|
||
|
||
### Companion apps | ||
|
||
* [t.vim](http://github.com/hkjels/t.vim/) - Use "T" directly from within vim | ||
|
||
|
||
*** | ||
|
||
|
||
### Contributors | ||
|
||
* Henrik Kjelsberg [github](http://github.com/hkjels/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
</div> | ||
</body> | ||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
<!DOCTYPE html> | ||
<html> | ||
<head> | ||
<meta charset='utf-8' /> | ||
<title>Todo - Taskmanagement, your way!</title> | ||
<style type='text/css'> | ||
html, body { | ||
height: 100%; | ||
} | ||
body { | ||
background: #232323; | ||
color: #aaa; | ||
font-family: 'Helvetica neue'; | ||
text-align: center; | ||
text-shadow: 0 1px 2px #111; | ||
} | ||
a { | ||
color: #ccc; | ||
display: inline-block; | ||
margin-right: 0.5em; | ||
text-decoration: none; | ||
} | ||
a:hover { | ||
color: #fff; | ||
} | ||
#wrapper { | ||
margin: 0 auto; | ||
max-width: 640px; | ||
padding: 4em 1em; | ||
text-align: left; | ||
} | ||
hr { | ||
background-color: #161616; | ||
box-shadow: 0 1px 0 #262626; | ||
border: none; | ||
height: 1px; | ||
margin: 3em 0; | ||
} | ||
header { | ||
font-size: 1.2em; | ||
margin: 4em 0 4em; | ||
} | ||
</style> | ||
</head> | ||
<body> | ||
<div id='wrapper'> | ||
<header> | ||
<nav> | ||
<a href='./index.html'>Home</a> | ||
<a href='./find.html'>Find</a> | ||
</nav> | ||
</header> |