From 42280f662d3ce4affb00eb68a22a081dfb951395 Mon Sep 17 00:00:00 2001
From: Francois Marier <francois@debian.org>
Date: Mon, 23 Jun 2008 23:47:09 +1200
Subject: Imported Upstream version 0.2.1

---
 README | 75 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 75 insertions(+)
 create mode 100644 README

(limited to 'README')

diff --git a/README b/README
new file mode 100644
index 0000000..607b470
--- /dev/null
+++ b/README
@@ -0,0 +1,75 @@
+===============================================================================
+
+Overview
+--------
+
+'cil' allows easy command-line creation of an issue tracker. It saves each
+issue locally and in plain text. Commands are given such that these issues can
+be added, edited and listed easily.
+
+===============================================================================
+
+Quick Start
+-----------
+
+Once installed, you should be able to run 'cil':
+
+ $ cil --help
+
+Now change directory to your current development project. To save the issues,
+'cil' requires setting up, so issue the 'init' command:
+
+ $ cil init
+
+This creates a '.cil' file and an 'issues/' directory.
+
+Then add an issue. An editor will pop-up and you fill in the details:
+
+ $ cil add
+
+After you've added it, you can see a representation of the issue. Now you can
+list all the issues by using the 'list' command:
+
+ $ cil list
+
+You can see what the issue name is by looking at the 'Issue' title. Imagine it
+is 'cafebabe' (which by default is the time from epoch). To see your issue
+again, use the 'show' command:
+
+ $ cil show cafebabe
+
+Another reporting command is 'summary':
+
+ $ cil summary
+
+The columns show 'Name', 'Status', 'CreatedBy' and 'Summary'.
+
+Shucks, we've noticed we got something wrong in the issue. Let's edit it:
+
+ $ cil edit cafebabe
+
+Save your changes and exit your editor. The issue is now saved. Try showing it
+again to make sure your changed are correct.
+
+We have just found out more about the issue so let's add a comment to it:
+
+ $ cil comment cafebabe
+
+When you show the issue again, you'll see the comment has been added and is now
+displayed.
+
+Adding an attachment is easy:
+
+ $ cil attach cafebabe core
+ ... added attachment 'decaf7ea' ...
+ $ cil show cafebabe
+
+If someone else added the attachment and you wish to view it, you can extract
+it from the issue:
+
+ $ cil extract decaf7ea --filename=mycore
+
+That's it for now. As you can see, if you've played with any kind of bug/issue
+tracker before, 'cil' is straightforward.
+
+===============================================================================
-- 
cgit v1.2.3