]> git.notmuchmail.org Git - notmuch/blobdiff - INSTALL
INSTALL: Add a pointer to ./configure --help
[notmuch] / INSTALL
diff --git a/INSTALL b/INSTALL
index 5a63211d26ee076fbfde466386f5ffb75e1f09c3..cadd3cec76ef43c7e804eb0aba66ecb0d7745595 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -9,10 +9,24 @@ sequence of:
        make
        sudo make install
 
-You can even skip the configure step if all of the dependencies of
-Notmuch are satisfied. If they are not, the configure script will
-notice that and provide instructions on where to obtain the necessary
-dependencies.
+In fact, if you don't plan to pass any arguments to the configure
+script, then you can skip that step and just start with "make", (which
+will call configure for you). See this command:
+
+       ./configure --help
+
+for detailed documentation of the things you can control at the
+configure stage.
+
+notmuch.el installation
+-----------------------
+Installing the notmuch.el emacs lisp function systemwide:
+
+       sudo make install-emacs
+
+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
 ------------
@@ -28,6 +42,11 @@ which are each described below:
 
        Xapian is available from http://xapian.org
 
+       After installing Xapian, please ensure that you have a command
+       named "xapian-config" on your $PATH as notmuch expects. (At
+       least one notmuch user found that Xapian installed the config
+       program to /usr/local/bin/xapian-config-1.1 ).
+
        GMime 2.4
        ---------
        GMime 2.4 provides decoding of MIME email messages for Notmuch.