Release 0.1.0

README.md

@@ -1,11 +1,11 @@
 ## Welcome to Pit ##
-Pit is simple command line project manager. I wrote it because I use Git a lot
+Pit is a command-line project manager that integrates with Git. I wrote it
-and needed similar command like tool for tracking my tasks. Besides, after years
+because I needed a command-line tool for tracking tasks. Besides, after
-of Ruby and JavaScript programming I somewhat missed plain C.
+years of Ruby and JavaScript programming I missed plain C.
 
 ### Installing Pit ###
-It is implemented in C and compiles down to single executable file. It has been
+Pit is implemented in C and compiles down to a single executable file. It
-tested to compile on Mac OS Leopard, Ubuntu, and RedHat Linux.
+has been tested to compile on Mac OS Leopard, Ubuntu, and RedHat Linux.
 
     $ git clone git://github.com/michaeldv/pit.git
     $ cd pit
@@ -18,25 +18,26 @@ tested to compile on Mac OS Leopard, Ubuntu, and RedHat Linux.
     0.1.0
 
 ### Basic Concepts ###
-Basic Pit entities are projects, tasks, and notes. A project can have many
+Basic Pit entities are projects, tasks, and notes. One project can have
-tasks, and a task can have many notes. Each entity has a number of attributes.
+multiple tasks, and a task can have multiple notes. Each entity has a number
-For example, a project has name and status, a task has name, status, priority,
+of attributes. For example, project has name and status, task has name,
-date, and time, and within a note there is a message body. All attributes
+status, priority, date, and time, and within note there is message body.
-except name and message body are optional and can be omitted.
+All attributes except name and message body are optional and can be omitted.
 
-The attributes have no semantic meaning and their values are not interpreted
+The attributes have no semantic meaning, and do not have a pre-defined set
-by Pit. For example, the time attribute could be used as projected time, time
+of values. For example, depending on the particular need, the time attribute
-spend on the task, or time left to finish the task.
+could be used as projected time in weeks, hours spent on the task, or days
+left to finish the task.
 
-Pit tries to maintain a notion "current" project, task, or note. For example,
+Pit tries to maintain a notion of "current" project, task, or note. When you
-when you create a new project it becomes current. If you create a task and
+create new project, it automatically becomes current. If you do not specify
-omit its project number the task will automatically be associated with current
+project number when creating a task, the new task will be associated with
-project.
+the current project.
 
 ### Pit Commands ###
 Pit commands are as follows:
 
-    init       Create empty Pit database or reinitialize an existing one
+    init       Create an empty Pit database or re-initialize an existing one
     project    Create, search, and manage Pit projects
     task       Create, search, and manage Pit tasks
     note       Create, search, and manage Pit notes
@@ -45,11 +46,62 @@ Pit commands are as follows:
     help       Show help information about Pit
     version    Show Pit version number
 
-All commands might be shortened as long as they remain unambiguous. For more
+All commands may be shortened, as long as they remain unambiguous. For more
 information on a specific command run:
 
     $ pit help <command> 
 
+### Git Integration ###
+Pit distribution comes with tools/commit-msg file. Copy this file to
+.git/hooks/commit-msg and make it executable:
+
+    $ cp ~/pit/tools/commit-msg .git/hooks
+    $ chmod +x .git/hooks/commit-msg
+
+Create git branch using task number as a branch name. Now on every commit to
+the branch the hook will prompt you to update task status. The hook appends
+Pit task number to the commit message, updates Pit task status, and creates
+task note with the commit massage. For example:
+
+    $ git checkout -b 2
+    Switched to a new branch '2'
+
+    $ touch README
+    $ git add .
+    $ git commit -am "Added README file"
+    What is the status of task 2?
+      (I)n progress
+      (P)ostponed
+      (O)pen
+      (D)one
+    Enter the status for task 2 [D]:
+    i
+    updated task 2: My second task (status: in progress)
+    created note 2: Added README file [task 2, status:in progress] (task 2)
+    [2 0d930fb] Added README file [task 2, status:in progress]
+     0 files changed, 0 insertions(+), 0 deletions(-)
+     create mode 100644 README
+
+### Tips ###
+A few tips to get you going:
+
+    # Changing default Pit file name: define PITFILE environment variable.
+    $ pit init
+    Created empty /Users/mike/.pit
+
+    $ export PITFILE="~/pit.db"
+    $ pit init
+    Created empty /Users/mike/pit.db
+
+    # Displaying last 10 lines of pit log in reverse order:
+    $ pit log|tail -10|sed -n '1!G;h;$p'
+
+    # Displaying tasks within certain date range:
+    $ pit task -q -d "Jan 1" -D "Sep 1"
+
+    # Displaying tasks with certain time range:
+    $ pit task -q -t 0:30 -T 8:00
+
 ### Sample Pit session ###
 
     $ pit init
@@ -58,27 +110,27 @@ information on a specific command run:
     $ pit project -c "My very first project"
     created project 1: My very first project (status: active)
 
-    $ pit p -c "My second project" -s backlog
+    $ pit project -c "My second project" -s backlog
     created project 2: My second project (status: backlog)
 
-    $ pit p
+    $ pit project
       1: (mike) |active | My very first project (0 tasks)
     * 2: (mike) |backlog| My second project     (0 tasks)
 
-    $ pit p -e 1 -s current
+    $ pit project -e 1 -s current
     updated project 1: My very first project (status: current)
 
-    $ pit p
+    $ pit project
     * 1: (mike) |current| My very first project (0 tasks)
       2: (mike) |backlog| My second project     (0 tasks)
 
     $ pit task -c "My very first task"
     created task 1: My very first task (status: open, priority: normal, project: 1)
 
-    $ pit t -c "My second task" -s new -p high
+    $ pit task -c "My second task" -s new -p high
     created task 2: My second task (status: new, priority: high, project: 1)
 
-    $ pit t -c "My third task" -p low -t 4:00
+    $ pit task -c "My third task" -p low -t 4:00
     created task 3: My third task (status: open, priority: low, time: 4:00, project: 1)
 
     $ pit p
@@ -90,30 +142,30 @@ information on a specific command run:
       2: (mike) |new | |high  |      My second task     (0 notes)
     * 3: (mike) |open| |low   | 4:00 My third task      (0 notes)
 
-    $ pit t -e -s new
+    $ pit task -e -s new
     updated task 3: My third task (status: new)
 
-    $ pit t -e 1 -d 10/10
+    $ pit task -e 1 -d 10/10
     updated task 1: My very first task (date: Oct 10, 2010)
     * 1: (mike) |open| |normal| Oct 10, 2010      My very first task (0 notes)
       2: (mike) |new | |high  |                   My second task     (0 notes)
       3: (mike) |new | |low   |              4:00 My third task      (0 notes)
 
-    $ pit n -c "Sample note for task #1"
+    $ pit note -c "Sample note for task #1"
     created note 1: Sample note for task #1 (task 1)
 
-    $ pit t -q -s new
+    $ pit task -q -s new
       2: (mike) |new| |high|      My second task (0 notes)
       3: (mike) |new| |low | 4:00 My third task  (0 notes)
 
-    $ pit t -m -p 2
+    $ pit task -m -p 2
     moved task 1: from project 1 to project 2
 
-    $ pit p 2
+    $ pit project 2
       1: (mike) |current| My very first project (2 tasks)
     * 2: (mike) |backlog| My second project     (1 task)    
 
-    $ pit p -d
+    $ pit project -d
     deleted note 1: Sample note for task #1 (task 1)
     deleted task 1: My very first task with 1 note (project: 2)
     deleted project 2: My second project with 1 task
@@ -134,53 +186,6 @@ information on a specific command run:
     Aug 22, 2010 14:33 (mike): deleted task 1: My very first task with 1 note (project: 2)
     Aug 22, 2010 14:33 (mike): deleted project 2: My second project with 1 task
 
-### Git Integration ###
-Pit distribution comes with tools/commit-msg file. Copy this file to
-.git/hooks/commit-msg and make it executable:
-
-    $ cp ~/pit/tools/commit-msg .git/hooks
-    $ chmod +x .git/hooks/commit-msg
-
-Create git branch using task number as a branch name. Now every time commit to the branch
-the hook will prompt you to update task status. The hook appends Pit task number to the
-commit message, updates Pit task status, and creates task note with the commit massage.
-For example:
-
-    $ git checkout -b 2
-    Switched to a new branch '2'
-
-    $ touch README
-    $ git add .
-    $ git commit -am "Added README file"
-    What is the status of task 2?
-      (I)n progress
-      (P)ostponed
-      (O)pen
-      (D)one
-    Enter the status for task 2 [D]: 
-    i
-    updated task 2: My second task (status: in progress)
-    created note 2: Added README file [task 2, status:in progress] (task 2)
-    [2 0d930fb] Added README file [task 2, status:in progress]
-     0 files changed, 0 insertions(+), 0 deletions(-)
-     create mode 100644 README
-
-### Tips ###
-
-    # Changing default Pit file name: define PITFILE environment variable.
-    $ pit init
-    Created empty /Users/mike/.pit
-
-    $ export PITFILE="~/pit.db"
-    $ pit init
-    Created empty /Users/mdvorkin/pit.db
-    
-    # Displaying last 10 lines of pit log in reverse order:
-    $ pit log|tail -10|sed -n '1!G;h;$p'
-
-    # Displaying tasks within certain date range:
-    $ pit task -q -d "Jan 1" -D "Sep 1"
-
 ### License ###
 Copyright (c) 2010 Michael Dvorkin