This commit was generated by cvs2svn to compensate for changes in r5444,
[elisp/gnus.git-] / README
1 This package contains a alpha version of Gnus.  The lisp directory
2 contains the source lisp files, and the texi directory contains a
3 draft of the Gnus info pages.
4
5 To use Gnus you first have to unpack the files, which you've obviously
6 done, because you are reading this.
7
8 You should definitely byte-compile the source files. To do that, you
9 can simply say "./configure && make" in this directory.  If you are
10 using XEmacs, you *must* say "make EMACS=xemacs".  In that case you
11 may also want to pull down the package of nice glyphs from
12 <URL:http://www.gnus.org/dist/etc.tar.gz>.  It should be installed
13 into the "gnus-5.6.53/etc" directory.
14
15 Then you have to tell Emacs where Gnus is. You might put something
16 like
17
18    (setq load-path (cons (expand-file-name "~/gnus-5.6.53/lisp") load-path))
19
20 in your .emacs file, or wherever you keep such things.  
21
22 To enable reading the Gnus manual, you could say something like:
23
24   (require 'info)
25   (setq Info-default-directory-list 
26         (cons "~/gnus-5.6.53/texi" Info-default-directory-list))
27
28 or
29
30   (require 'info)
31   (setq Info-directory-list 
32         (cons "~/gnus-5.6.53/texi" Info-directory-list))
33
34 depending on which version of Emacs or XEmacs you're using.
35
36 Note that Gnus and GNUS can't coexist in a single Emacs. They both use
37 the same function and variable names.  If you have been running GNUS
38 in your Emacs, you should probably exit that Emacs and start a new one
39 to fire up Gnus.
40
41 Gnus does absolutely not work with anything older than Emacs 20.3 or
42 XEmacs 20.0.  So you definitely need a new Emacs.
43
44 Then you do a `M-x gnus', and everything should... uhm... it should
45 work, but it might not. Set `debug-on-error' to t, and mail me the
46 backtraces, or, better yet, find out why Gnus does something wrong,
47 fix it, and send me the diffs. :-)
48
49 There are four main things I want your help and input on:
50
51 1) Startup. Does everything go smoothly, and why not?
52
53 2) Any errors while you read news normally?
54
55 3) Any errors if you do anything abnormal?
56
57 4) Features you do not like, or do like, but would like to tweak a
58    bit, and features you would like to see.
59
60 Send any comments and all your bug fixes/complaints to
61 `bugs@gnus.org'.