

VITtk - Visual Interactive Task written in tcl/tk
-------------------------------------------------
...it's a samurai sword for taskwarriors who like vi.

Please read the "Tutorial" file.  For the impatient, here's "quick start" 
instructions which use a new task data store...

 $ ./configure
 $ make install
 $ mkdir /tmp/.task-test
 $ task rc.data.location=/tmp/.task-test add This is a task
 $ task rc.data.location=/tmp/.task-test add This is another task
 $ vittk -h
 $ vittk -ds /tmp/.task-test -d > /tmp/vittk-debug.log
 $ more /tmp/vittk-$USER.log
 $ more /tmp/vittk-debug.log

If you have problems, check the TODO file.  If you don't see any indication
of your problem there, run "vittk -d" and send me the output.  Thanks!

steve rader
<rader@hep.wisc.edu>


Requirements
------------

VITtk requires Xwindows, tcl/tk, and of course Taskwarrior. Almost all modern
Linux and Mac computers come with Xwindows and tcl/tk installed. If you run
Linux and you don't tcl/tk (i.e. /usr/bin/wish) then you should install the
"tcl" and "tk" packages using your native package manager. Mac-OSX users with
10.5 (Leopard) or newer should have Xwindows and tcl/tk already installed.
Users of prior Mac-OSX versions should install Xwindows and tcl/tk using
their OS X install CD.


What VITtk Does
---------------
VITtk allows you to view Taskwarrior reports and do Taskwarrior commands
using modes and commands very much like those in the VI Editor (aka "vi".)
VITtk is not a graphical user interface--rather it's a character-based
full screen terminal interface, which just happens to be implemented with a
GUI toolkit (tcl/tk.)  VITtk maintains an audit log which allows you to 
investigate the changes it makes to your Taskwarrior data store.


What VITtk Does Not Do
----------------------
1) It does not protect you from yourself.  Use it with extreme caution.
2) It does not alter the reporting output from Taskwarrior: it is just a 
   wrapper around the "task" command.  While VITtk can't change the sort 
   order of a given report, it can display a report you define in 
   Taskwarrior that changes sort order.  
3) It does not do "task undo" because of bug #634.
4) It does not do "task edit"--use VI for that, silly you!  
There are a number of other minor constraints listed in the "Caveats" file.


What VITtk Will Do Someday
--------------------------
...not much else.  Once Taskwarrior provides network application layer support,
the development of VITtk may stop and work may start on just "VIT": the same
VITtk user interface, but written in C and using real terminals.  VITtk really
started out as a "proof of concept" then became a "stop-gap measure" but it
has grown beyond that.  There is a rumor that VIT will heavily influence or
perhaps even supplant the Taskwarrior 3.0 full screen terminal interface.


