diff --git a/.gitignore b/.gitignore index 99c6da2..0a01fb1 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,7 @@ # Directories -docs -node_modules .todo +node_modules +res test @@ -10,5 +10,6 @@ test # Files +docs/*.html .DS_Store .todoignore diff --git a/.npmignore b/.npmignore index 3bdd868..0c71f5f 100644 --- a/.npmignore +++ b/.npmignore @@ -3,4 +3,6 @@ .gitignore .todo .todoignore +docs +res test diff --git a/Readme.md b/Readme.md index 1c01379..dd549df 100644 --- a/Readme.md +++ b/Readme.md @@ -1,4 +1,4 @@ -# Todo - Work in progress (Launch @ 1st of March) +# Todo ### Taskmanagement, your way! @@ -12,7 +12,8 @@ issue-trackers, so one does not exclude the other.__ Make sure you install __Todo__ globally "__-g__" - $ npm install todo -g +_Npm installation is unfortunately not up and running at the moment_ + $ npm install *** -g ## Getting started @@ -28,7 +29,7 @@ Update taskpool Find tasks - $ t find "#todo" + $ t find "" ## Features diff --git a/Todo.md b/Todo.md index 3ffcce9..94f8281 100644 --- a/Todo.md +++ b/Todo.md @@ -5,17 +5,19 @@ __Tip: Create a taskpool similar to this one at the root of your project for rap * TODO #Research how one can track hours. - | Could possibly be done by tracking labels for changes. - | Or maybe by having a unit-column. It could then be possible to have timers. + | Could possibly be done by tracking labels for changes. + | Or maybe by having a unit-column. It could then be possible to use timers. -* TODO #github #thub todo-github should be able to add/modify/delete issues - -* TODO @henrik Add #config possibilities #v[0.0.3] +* TODO @henrik Add #config possibilities #v[0.0.4] | Using .todoconfig in HOME or in the project-root +* FIXME Write tests!! Ensure that old-style todo's really are logged + | I have heard that code-coverage is a good idea aswell + +* BUG Database can end up corrupted at times #imd[2371b070] + * TODO Closing tasks should be possible through the use of keywords (CLOSE|CLOSES|CLOSED|FIXES|FIXED) - | or by manually removing them from the code. Closed tasks should still exist - | in the index, but be compacted if it stays closed for a longer period of time. + | or by querying for tasks with the a remove-flag * OPTIMIZE GUI to perform somewhat realtime diff --git a/bin/todo b/bin/todo index 74d7bb1..89dbacd 100755 --- a/bin/todo +++ b/bin/todo @@ -16,13 +16,13 @@ program .version(todo.version, '-v, --version') .option('-l, --limit ', 'Limit the results output', parseInt) .option('-r, --reverse', 'Reverse the sort-order') - .option('-c, --count', 'Supress normal output. Output number of tasks instead') + .option('-c, --count', 'Supress normal output. Output number of tasks instead\n') .option('-b, --body', 'Output the body of each task') - .option('-i, --id', 'Ouput the id of each task') + .option('-i, --id', 'Ouput the id of each task\n') .option('-N, --no-line', 'Supress output of line-numbers.') .option('-H, --no-filename', 'Supress output of filenames.') .option('-C, --no-color', 'Prevent colored output') - .option('-G, --no-group', 'Prevent grouping by filename') + .option('-G, --no-group', 'Prevent grouping by filename\n') .option('-q, --quiet', 'Will run without output') // Initialize a new project diff --git a/docs/find.md b/docs/find.md new file mode 100644 index 0000000..fcf3edf --- /dev/null +++ b/docs/find.md @@ -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] diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..4b12f02 --- /dev/null +++ b/docs/index.md @@ -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 + + gui [path] [port] + +#### Options: + + -h, --help output usage information + -v, --version output the version number + -l, --limit 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/) diff --git a/docs/layout/foot.html b/docs/layout/foot.html new file mode 100644 index 0000000..5b6e2d6 --- /dev/null +++ b/docs/layout/foot.html @@ -0,0 +1,3 @@ + + + diff --git a/docs/layout/head.html b/docs/layout/head.html new file mode 100644 index 0000000..51796f3 --- /dev/null +++ b/docs/layout/head.html @@ -0,0 +1,52 @@ + + + + + Todo - Taskmanagement, your way! + + + +
+
+ +