From aac1d6035238f6a2b18c0dc0d7a5190a2187c511 Mon Sep 17 00:00:00 2001 From: Carl Worth <cworth@cworth.org> Date: Sat, 21 Nov 2009 21:40:57 +0100 Subject: [PATCH] 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. --- INSTALL | 4 +++- notmuch.el | 28 ++++++++++++++++++++++++++++ 2 files changed, 31 insertions(+), 1 deletion(-) diff --git a/INSTALL b/INSTALL index 64b8e362..c0b67a31 100644 --- a/INSTALL +++ b/INSTALL @@ -20,7 +20,9 @@ Installing the notmuch.el emacs lisp function systemwide: 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 ------------ diff --git a/notmuch.el b/notmuch.el index cd3780fa..0144b612 100644 --- a/notmuch.el +++ b/notmuch.el @@ -19,6 +19,34 @@ ; ; 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 'mm-view) -- 2.45.2