Wrote README file, updated help, added make install

Makefile

@@ -83,6 +83,9 @@ $(OBJDIR)/task.o: $(SRCDIR)/task.c $(SRCDIR)/pit.h $(SRCDIR)/object.h $(SRCDIR)/
 $(OBJDIR)/util.o: $(SRCDIR)/util.c $(SRCDIR)/pit.h $(SRCDIR)/object.h $(SRCDIR)/table.h
 	$(CC) -o $(OBJDIR)/util.o -c $(SRCDIR)/util.c
 
+install:
+	cp $(BINDIR)/pit /usr/local/bin
+
 clean:
 	rm -f $(OBJDIR)/*.o
 	rm -f $(BINDIR)/$(APP)

README

@@ -0,0 +1,200 @@
+## Welcome to Pit ##
+Pit is simple command line project manager. I wrote it because I use Git a lot
+and needed similar command like tool for tracking my tasks. Besides, after years
+of Ruby and JavaScript programming I somewhat missed plain C.
+
+### Installing Pit ###
+It is implemented in C and compiles down to single executable file. It has been
+tested to compile on Mac OS Leopard, Ubuntu, and RedHat Linux.
+
+    $ git clone git://github.com/michaeldv/pit.git
+    $ cd pit
+    $ make
+    $ make test     # <-- Optional, requires Ruby
+    $ sudo make install
+    $ which pit
+    /usr/local/bin/pit
+    $ pit version
+    0.1.0
+
+### Basic Concepts ###
+Basic Pit entities are projects, tasks, and notes. A project can have many
+tasks, and a task can have many notes. Each entity has a number of attributes.
+For example, a project has name and status, a task has name, status, priority,
+date, and time, and within a note there is a message body. 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
+by Pit. For example, the time attribute could be used as projected time, time
+spend on the task, or time left to finish the task.
+
+Pit tries to maintain a notion "current" project, task, or note. For example,
+when you create a new project it becomes current. If you create a task and
+omit its project number the task will automatically be associated with current
+project.
+
+### Pit Commands ###
+Pit commands are as follows:
+
+    init       Create empty Pit database or reinitialize an existing one
+    project    Create, search, and manage Pit projects
+    task       Create, search, and manage Pit tasks
+    note       Create, search, and manage Pit notes
+    log        Show chronological Pit activity log
+    info       Show summary information about your Pit database
+    help       Show help information about Pit
+    version    Show Pit version number
+
+All commands might be shortened as long as they remain unambiguous. For more
+information on a specific command run:
+
+    $ pit help <command> 
+
+### Sample Pit session ###
+
+    $ pit init
+    Created empty /Users/mike/.pit
+
+    $ pit project -c "My very first project"
+    created project 1: My very first project (status: active)
+
+    $ pit p -c "My second project" -s backlog
+    created project 2: My second project (status: backlog)
+
+    $ pit p
+      1: (mike) |active | My very first project (0 tasks)
+    * 2: (mike) |backlog| My second project     (0 tasks)
+
+    $ pit p -e 1 -s current
+    updated project 1: My very first project (status: current)
+
+    $ pit p
+    * 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
+    created task 2: My second task (status: new, priority: high, project: 1)
+
+    $ pit t -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
+    * 1: (mike) |current| My very first project (3 tasks)
+      2: (mike) |backlog| My second project     (0 tasks)
+
+    $ pit t
+      1: (mike) |open| |normal|      My very first task (0 notes)
+      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
+    updated task 3: My third task (status: new)
+
+    $ pit t -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"
+    created note 1: Sample note for task #1 (task 1)
+
+    $ pit t -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
+    moved task 1: from project 1 to project 2
+
+    $ pit p 2
+      1: (mike) |current| My very first project (2 tasks)
+    * 2: (mike) |backlog| My second project     (1 task)    
+
+    $ pit p -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
+
+    $ pit log
+    Aug 22, 2010 14:30 (mike): Initialized pit
+    Aug 22, 2010 14:31 (mike): created project 1: My very first project (status: active)
+    Aug 22, 2010 14:31 (mike): created project 2: My second project (status: backlog)
+    Aug 22, 2010 14:31 (mike): updated project 1: My very first project (status: current)
+    Aug 22, 2010 14:31 (mike): created task 1: My very first task (status: open, priority: normal, project: 1)
+    Aug 22, 2010 14:31 (mike): created task 2: My second task (status: new, priority: high, project: 1)
+    Aug 22, 2010 14:31 (mike): created task 3: My third task (status: open, priority: low, time: 4:00, project: 1)
+    Aug 22, 2010 14:32 (mike): updated task 3: My third task (status: new)
+    Aug 22, 2010 14:32 (mike): updated task 1: My very first task (date: Oct 10, 2010)
+    Aug 22, 2010 14:32 (mike): created note 1: Sample note for task #1 (task 1)
+    Aug 22, 2010 14:33 (mike): moved task 1: from project 1 to project 2
+    Aug 22, 2010 14:33 (mike): deleted note 1: Sample note for task #1 (task 1)
+    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
+mike[at]dvorkin.net aka mike[at]fatfreecrm.com
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS 
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE 
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Released under the Simplified BSD license. See LICENSE file for details.

src/help.c

@@ -17,16 +17,17 @@
 static void usage()
 {
     char *msg[] = {
+        "Pit is highly experimental software. Use it at your own risk. See LICENSE file for details.",
         "usage: pit command [args]\n",
         "The commands are:",
-        "   init       Create empty pit database or reinitialize an existing one",
+        "   init       Create empty Pit database or reinitialize an existing one",
-        "   project    Create, search, and manage pit projects",
+        "   project    Create, search, and manage Pit projects",
-        "   task       Create, search, and manage pit tasks",
+        "   task       Create, search, and manage Pit tasks",
-        "   note       Create, search, and manage pit notes",
+        "   note       Create, search, and manage Pit notes",
-        "   log        Show chronological pit activity log",
+        "   log        Show chronological Pit activity log",
-        "   info       Show summary information about your pit database",
+        "   info       Show summary information about your Pit database",
-        "   help       Show help information about pit",
+        "   help       Show help information about Pit",
-        "   version    Show pit version number\n",
+        "   version    Show Pit version number\n",
         "All commands might be shortened as long as they remain unambiguous. See 'pit help <command>' for more",
         "information on a specific command.\n", NULL
     };
@@ -36,8 +37,7 @@ static void usage()
 static void help_project()
 {
     char *msg[] = {
-        "Pit project is basic entity used to group related tasks together. In pit project has name and status, neither",
+        "Pit project is basic entity used to group related tasks together. A project has name and status.\n", 
-        "of which have any semantical meaning and are just arbitrary strings.\n", 
         "Creating a project:\n",
         "   $ pit project -c name [-s status]\n",
         "Editing a project:\n",
@@ -72,8 +72,8 @@ static void help_project()
 static void help_task()
 {
     char *msg[] = {
-        "In pit a task belongs to particular project. A task has name, status, priority, date, and time. All attributes",
+        "In Pit a task belongs to a project and projects can have many tasks. Task attributes include name, status,",
-        "except the task name are optional.\n",
+        "priority, date, and time. All attributes except the name are optional.\n",
         "Creating a task:\n",
         "   pit task -c name [-s status] [-p priority] [-d date] [-t time]\n",
         "Editing a task:\n",
@@ -114,13 +114,24 @@ static void help_task()
 
 static void help_note()
 {
-    puts("pit note is not implemented yet.");
+    char *msg[] = {
+        "Pit notes are attached to a task. The only attribute is the note's message body.\n",
+        "Creating a note:\n",
+        "  $ pit note -c message\n",
+        "Editing a note:\n",
+        "  $ pit note -e [number] message\n",
+        "Deleting a note:\n",
+        "  $ pit note -d [number]\n",
+        "Listing notes:\n",
+        "  $ pit note\n", NULL
+    };
+    printa(msg);
 }
 
 static void help_log()
 {
     char *msg[] = {
-        "Show summary information about your pit database. This command is as simple as:\n",
+        "Show summary information about your Pit database. This command is as simple as:\n",
         "   pit log\n", NULL
     };
     printa(msg);
@@ -129,7 +140,7 @@ static void help_log()
 static void help_init()
 {
     char *msg[] = {
-        "Create empty pit database or reinitialize an existing one. Default file name for the pit database",
+        "Create empty Pit database or reinitialize an existing one. Default file name for the Pit database",
         "is ~/.pit -- you can override the default by setting PITFILE environment variable.\n",
         "   $ pit init [-f]\n",
         "   -f   force initialization without prompt\n",
@@ -144,7 +155,7 @@ static void help_init()
 static void help_info()
 {
     char *msg[] = {
-        "Show summary information about your pit database. This command is as simple as:\n",
+        "Show summary information about your Pit database. This command is as simple as:\n",
         "   pit info\n", NULL
     };
     printa(msg);

src/task.c

@@ -176,6 +176,7 @@ static void task_move(int id, POptions po)
         pp = (PProject)pit_table_find(projects, po->task.project_id);
         if (pp) {
             id = task_find_current(id, &pt);
+            PProject px = (PProject)pit_table_find(projects, pt->project_id);
             /*
             ** Log before changing the project so we could show old and new values.
             */
@@ -187,6 +188,8 @@ static void task_move(int id, POptions po)
             */
             pit_table_mark(tasks, pt->id);
             pit_table_mark(projects, pp->id);
+            px->number_of_tasks--;
+            pp->number_of_tasks++;
             pit_db_save();
         } else {
             die("could not find project %d", po->task.project_id);