Permalink
Browse files

Added copyrights, instructions and license information

  • Loading branch information...
1 parent 99536b4 commit 55f2f4fd15c26d5d04d9eceee09084bf46dcf702 @chilts committed Apr 19, 2008
Showing with 881 additions and 0 deletions.
  1. +674 −0 COPYING
  2. +39 −0 INSTALLATION
  3. +72 −0 README
  4. +16 −0 bin/cil
  5. +20 −0 lib/CIL/Attachment.pm
  6. +20 −0 lib/CIL/Base.pm
  7. +20 −0 lib/CIL/Comment.pm
  8. +20 −0 lib/CIL/Issue.pm
View
674 COPYING

Large diffs are not rendered by default.

Oops, something went wrong.
View
@@ -0,0 +1,39 @@
+===============================================================================
+
+Dependencies
+------------
+
+Perl Modules:
+ * Term::CallEditor
+ * File::Touch
+ * File::Glob
+ * File::Basename
+ * YAML
+ * Config::IniFiles
+
+For Debian Etch, the following packages will need to be installed:
+ * perl-code
+ * libfile-touch-perl
+ * libfile-glob-perl
+ * libfile-basename-perl
+ * libyaml-perl
+ * libconfig-inifiles-perl
+
+Currently, Term::CallEditor is not in Etch and therefore will have to be added
+via other means. If you want to build a package from CPAN try the following:
+
+ $ dh-make-perl --build --cpan Term::CallEditor
+
+and install the newly created package.
+
+ $ sudo dpkg -i libterm-calleditor-perl
+
+===============================================================================
+
+Debian Packages
+---------------
+
+Soon I will have packages in my repository on kapiti.geek.nz. Please come back
+later :-)
+
+===============================================================================
View
72 README
@@ -0,0 +1,72 @@
+===============================================================================
+
+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 '1208598003' (which by default is the time from epoch). To see your issue
+again, use the 'show' command:
+
+ $ cil show 1208598003
+
+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 1208598003
+
+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 1208598003
+
+When you show the issue again, you'll see the comment has been added and is now
+displayed.
+
+That's it for now. As you can see, if you've played with any kind of bug/issue
+tracker before, 'cil' is straightforward.
+
+===============================================================================
+
+Future Work
+-----------
+
+Currently, cil is still young. There are a number of improvements I wish to do
+on it but already it is useable as a small and personal issue tracker.
+
+===============================================================================
View
16 bin/cil
@@ -1,5 +1,21 @@
#!/usr/bin/perl
## ----------------------------------------------------------------------------
+# cil is a Command line Issue List
+# Copyright (C) 2008 Andrew Chilton
+#
+# 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 3 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, see <http://www.gnu.org/licenses/>.
+## ----------------------------------------------------------------------------
use strict;
use warnings;
View
@@ -1,4 +1,24 @@
## ----------------------------------------------------------------------------
+# cil is a Command line Issue List
+# Copyright (C) 2008 Andrew Chilton
+#
+# This file is part of 'cil'.
+#
+# cil 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 3 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, see <http://www.gnu.org/licenses/>.
+#
+## ----------------------------------------------------------------------------
+
package CIL::Attachment;
use strict;
View
@@ -1,4 +1,24 @@
## ----------------------------------------------------------------------------
+# cil is a Command line Issue List
+# Copyright (C) 2008 Andrew Chilton
+#
+# This file is part of 'cil'.
+#
+# cil 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 3 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, see <http://www.gnu.org/licenses/>.
+#
+## ----------------------------------------------------------------------------
+
package CIL::Base;
use strict;
View
@@ -1,4 +1,24 @@
## ----------------------------------------------------------------------------
+# cil is a Command line Issue List
+# Copyright (C) 2008 Andrew Chilton
+#
+# This file is part of 'cil'.
+#
+# cil 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 3 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, see <http://www.gnu.org/licenses/>.
+#
+## ----------------------------------------------------------------------------
+
package CIL::Comment;
use strict;
View
@@ -1,4 +1,24 @@
## ----------------------------------------------------------------------------
+# cil is a Command line Issue List
+# Copyright (C) 2008 Andrew Chilton
+#
+# This file is part of 'cil'.
+#
+# cil 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 3 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, see <http://www.gnu.org/licenses/>.
+#
+## ----------------------------------------------------------------------------
+
package CIL::Issue;
use strict;

0 comments on commit 55f2f4f

Please sign in to comment.