* nnmairix.el: Remove old documentation in the commentary block.
[gnus.git] / README
blobf4216206df222563a9c032ec04120429f9fa69bd
1 * Content
3 This package contains a development version of Gnus.  The lisp directory
4 contains the source lisp files, and the texi directory contains the Gnus info
5 pages.
7 * Emacsen
9 No Gnus does absolutely not work with anything older than Emacs 21 or
10 XEmacs 21.4.
12 Users of the Emacs development version (Emacs 23) are strongly encouraged to
13 also use the version bundled with Emacs.
15 * Setup
17 To use Gnus you first have to unpack the files, which you've obviously
18 done, because you are reading this.
20 You should definitely byte-compile the source files.  To do that, you
21 can simply say "./configure && make" in this directory.
23 Do not say "make install".  I repeat, do *NOT* say "make install".  If
24 you say "make install" and then complain about things not working,
25 I'll be very annoyed.  If you say "make install" and things happen to
26 work, that's all fine and dandy for you, but it's quite likely that it
27 won't.
29 If you are using XEmacs, you *must* say "./configure && make EMACS=xemacs".
31 Then you have to tell Emacs where Gnus is.  You might put something
32 like
34    (setq load-path (cons (expand-file-name "~/ngnus-0.11/lisp") load-path))
35    (require 'gnus-load)
37 in your .emacs file, or wherever you keep such things.  
39 To enable reading the Gnus manual, you could say something like:
41   (require 'info)
42   (if (featurep 'xemacs)
43       (add-to-list 'Info-directory-list "~/ngnus-0.11/texi/")
44     (add-to-list 'Info-default-directory-list "~/ngnus-0.11/texi/"))
46 To compile the Gnus manual, you either need a pretty new Emacs, or a
47 pretty new version of the texinfo tools.
49 Then you do a `M-x gnus', and everything should... uhm... it should
50 work, but it might not.  Set `debug-on-error' to t, and mail me the
51 backtraces, or, better yet, find out why Gnus does something wrong,
52 fix it, and send me the diffs.  :-)
54 There are four main things I want your help and input on:
56 1) Startup.  Does everything go smoothly, and why not?
58 2) Any errors while you read news normally?
60 3) Any errors if you do anything abnormal?
62 4) Features you do not like, or do like, but would like to tweak a
63    bit, and features you would like to see.
65 Send any comments and all your bug fixes/complaints to
66 `bugs@gnus.org'.
69 Local variables:
70 mode: outline
71 End: