--- a/bug Tue Oct 24 18:00:31 2006 +0200
+++ b/bug Tue Oct 24 20:39:28 2006 +0200
@@ -1,4 +1,50 @@
#!/bin/bash
+# (encoding: UTF-8)
+#
+# Simple Bug / ToDo tracker for the command line.
+# (Instructions below the license)
+# LICENSE
+# Copyright (C) 2006 LluĂs Batlle i Rossell
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+# Instructions:
+# 1. Your $BUG_PROJECT should point to a file. It will be the database you'll
+# be using. Use an absolute path. It may be, for instance, "~/todo.bug"
+#
+# Having the $BUG_PROJECT set:
+# 1. Create the database:
+# bug create
+# 2. Add an issue
+# bug add
+# Use integers for the priorities. Higher -> more priority.
+# Use any words you prefer for the state
+# Don't break the number of lines until "-- Description --". Write
+# multilines only below that label.
+# 3. List the issues (all but description, priority sorted)
+# bug list [ | grep as_you_wish ]
+# 4. View an issue
+# bug view <ID>
+# 5. Edit an issue
+# bug edit <ID>
+# Change the state, the priority, add data as long as you fix it, ...
+# When I consider an issue is fulfilled, I negate its priority.
+# 6. Delete an issue
+# bug delete <ID>
+# Do that whenever you will not need the issue anymore.
+#
PNAME=`basename "$0"`
CMD="$1"