Skip to content
Newer
Older
100644 77 lines (47 sloc) 1.93 KB
10ded42 @kentaro Initial release.
authored Apr 11, 2008
1 README for emacs-ditz
2 =====================
3
4 * Description
5
7b26e15 @kentaro Tidied README.
authored Apr 11, 2008
6 emacs-ditz provides ditz.el, Emacs interface to Ditz issue tracking
7 system. You can get Ditz from http://ditz.rubyforge.org/.
10ded42 @kentaro Initial release.
authored Apr 10, 2008
8
9 * Usage
10
11 (1) Checkout from repository.
12
13 $ git clone git://github.com/kentaro/emacs-ditz.git
14
15 (2) Add the checkout directory into your load-path.
16
17 (add-to-list 'load-path "/path/to/emacs-ditz")
18
19 (3) Load dzit.el.
20
21 (require 'ditz)
22
23 (4) Set some variables as you like.
24
25 ;; Path to the ditz command (default: "ditz")
26 (setq ditz-program "/path/to/ditz")
27
28 ;; If you don't want to always set issue dir when you run commands,
d3cb077 @kentaro Fixed typos in documentation.
authored Apr 11, 2008
29 ;; ditz.el provides automatic finding functionality. Add the
30 ;; settings below:
10ded42 @kentaro Initial release.
authored Apr 10, 2008
31
32 ;; Issue directory name (default: "bugs")
33 (setq ditz-issue-directory "issues")
34
35 ;; Enable automatic finding functionality.
36 (setq ditz-find-issue-directory-automatically-flag t))
37
38 (5) Run M-x ditz-init to initialize your ditz issues.
39
40 (6) Run M-x ditz-add-release to add a new release.
41
42 (7) Run M-x ditz-add to add a new issue
43
44 (8) M-x ditz-status, ditz-todo, ditz-todo, ditz-log are useful for
45 browsing your issues.
46
47 (9) To change issues/releases' status:
48
49 [1] Run M-x ditz-todo to list issues up.
50 [2] Enter the keys below on underlined strings:
51
52 - "s": ditz-show (Show issue's detail)
88af9c2 @kentaro Release 0.3.
authored Apr 11, 2008
53 - "e": ditz-edit (Edit issue's detail)
10ded42 @kentaro Initial release.
authored Apr 10, 2008
54 - "a": ditz-assign (Assign/reassign issue to a release)
55 - "c": ditz-close (Close issue)
56 - "r": ditz-release (Mark release as done)
57 - "g": ditz-reload (Reload status/todo/log buffer)
58 - "q": ditz-close-buffer (Close ditz-mode buffer)
59
bb93b28 @kentaro Now ditz-todo/status/log run display-window not pop-to-buffer.
authored Apr 11, 2008
60 (10) M-x ditz-html generates HTML files including all statuses.
a5c8828 @kentaro Add support for `ditz html' command.
authored Apr 11, 2008
61
bb93b28 @kentaro Now ditz-todo/status/log run display-window not pop-to-buffer.
authored Apr 11, 2008
62 (11) For the usage of Ditz itself, see the document below:
10ded42 @kentaro Initial release.
authored Apr 10, 2008
63
64 http://ditz.rubyforge.org/README.txt
65
66 * CAVEAT
67
68 - ditz-edit now doesn't work because `ditz edit issue-id' doesn't
69 work on Emacs.
70
71 * AUTHOR
72
73 Kentaro Kuribayashi
74
75 kentarok@gmail.com
76 http://kentarok.org/
Something went wrong with that request. Please try again.