- Updated docs, announced deprecation of TUTORIAL.

This commit is contained in:
Paul Beckingham 2008-07-09 03:39:29 -04:00
parent cf27fa027b
commit ec8da0baaa
4 changed files with 25 additions and 2 deletions

View file

@ -1,9 +1,11 @@
Developers may wish to change task, and here is a high-level guide to the files
included.
task.{cpp,h} Functions that implement the task commands, and main.
task.{cpp,h} Implements main, high level processing.
command.cpp Implements all non-report task commands.
report.cpp Implements all task reports.
parse.cpp Parses the command line.
TDB.{cpp,h} The task database, performs all file I/O
TDB.{cpp,h} The task database, performs all file I/O.
T.{cpp,h} Represents a single task - parses a record from TDB, and also
composes record for TDB. Provides accessors for tasks.
Grid.{cpp,h} Implements a sparse 2D array, provides data storage for the

6
README
View file

@ -30,6 +30,12 @@ it fits in to your way of working. As a command line application, task is not
for everyone and some of you may prefer to not proceed. The movie or TUTORIAL
file are the quickest way for you to make that decision.
Please note that the TUTORIAL file included is deprecated, and will be removed
at the next major release of task. It is superceded by an HTML tutorial that
can be found at:
http://www.beckingham.net/task.html
Task is based on ideas presented in the todo.sh script, found on:
http://todotxt.org

View file

@ -1,6 +1,19 @@
Task program tutorial, for version 1.4.0
----------------------------------------
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
This TUTORIAL file is deprecated. It will not be included in future releases
of task, and will be superceded by an online version that can be found at:
http://www.beckingham.net/task.html
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
This guide shows how to quickly set up the task program, and become proficient
with it.

View file

@ -213,6 +213,8 @@ static void longUsage (Config& conf)
<< " project: Project name" << "\n"
<< " priority: Priority" << "\n"
<< " due: Due date" << "\n"
<< " recur: Recurrence frequency" << "\n"
<< " until: Recurrence end date" << "\n"
<< " fg: Foreground color" << "\n"
<< " bg: Background color" << "\n"
<< " rc: Alternate .taskrc file" << "\n"