README for emacs-ditz
=====================

* Description

emacs-ditz provides ditz.el, Emacs interface to Ditz issue tracking
system. You can get Ditz from http://ditz.rubyforge.org/.

* Usage

(1) Checkout from repository.

  $ git clone git://github.com/kentaro/emacs-ditz.git

(2) Add the checkout directory into your load-path.

  (add-to-list 'load-path "/path/to/emacs-ditz")
  
(3) Load dzit.el.

  (require 'ditz)

(4) Set some variables as you like.

  ;; Path to the ditz command (default: "ditz")
  (setq ditz-program "/path/to/ditz")

  ;; If you don't want to always set issue dir when you run commands,
  ;; ditz.el provides automatic finding functionality. Add the
  ;; settings below:

  ;; Issue directory name (default: "bugs")
  (setq ditz-issue-directory "issues")

  ;; Enable automatic finding functionality (default: nil)
  (setq ditz-find-issue-directory-automatically-flag t)

(5) Run M-x ditz-init to initialize your ditz issues.

(6) Run M-x ditz-add-release to add a new release.

(7) Run M-x ditz-add to add a new issue

(8) M-x ditz-status, ditz-todo, ditz-log are useful for browsing your
  issues.

(9) To change issues/releases' status:

  [1] Run M-x ditz-todo to list issues up.
  [2] Enter the keys below on underlined strings:

    - "A": ditz-add          (Add issue)
    - "D": ditz-drop         (Drop issue)
    - "s": ditz-show         (Show issue's detail)
    - "e": ditz-edit         (Edit issue's detail)
    - "a": ditz-assign       (Assign/reassign issue to a release)
    - "c": ditz-close        (Close issue)
    - "r": ditz-release      (Mark release as done)
    - "g": ditz-reload       (Reload status/todo/log buffer)
    - "q": ditz-close-buffer (Close ditz-mode buffer)

(10) M-x ditz-html generates HTML files including all statuses.

(11) For the usage of Ditz itself, see the document below:

  http://ditz.rubyforge.org/README.txt

* Author

Kentaro Kuribayashi

kentarok@gmail.com
http://kentarok.org/

* License

Copyright (C) 2008 Kentaro Kuribayashi

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/>.