INSTALL/notmuch.el: More details on how to install/run notmuch.el

Hopefully this will save some people some head-scratching trying
to figure out how to use it.
This commit is contained in:
Carl Worth 2009-11-21 21:40:57 +01:00
parent 0414c774d2
commit aac1d60352
2 changed files with 31 additions and 1 deletions

View file

@ -20,7 +20,9 @@ Installing the notmuch.el emacs lisp function systemwide:
sudo make install-emacs sudo make install-emacs
Each user needs to add (require 'notmuch) in his ~/.emacs to activate it. Each user needs to add (require 'notmuch) in his ~/.emacs to make it
available and then start emacs running notmuch with "emacs -f notmuch"
or start notmuch from within emacs with "M-x notmuch".
Dependencies Dependencies
------------ ------------

View file

@ -19,6 +19,34 @@
; ;
; Authors: Carl Worth <cworth@cworth.org> ; Authors: Carl Worth <cworth@cworth.org>
; This is an emacs-based interface to the notmuch mail system.
;
; You will first need to have the notmuch program installed and have a
; notmuch database built in order to use this. See
; http://notmuchmail.org for details.
;
; To install this software, copy it to a directory that is on the
; `load-path' variable within emacs (a good candidate is
; /usr/local/share/emacs/site-lisp). If you are viewing this from the
; notmuch source distribution then you can simply run:
;
; sudo make install-emacs
;
; to install it.
;
; Then, to actually run it, add:
;
; (require 'notmuch)
;
; to your ~/.emacs file, and then run "M-x notmuch" from within emacs,
; or run:
;
; emacs -f notmuch
;
; Have fun, and let us know if you have any comment, questions, or
; kudos: Notmuch list <notmuch@notmuchmail.org> (subscription is not
; required, but is available from http://notmuchmail.org).
(require 'cl) (require 'cl)
(require 'mm-view) (require 'mm-view)