X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=INSTALL;h=4a0dc74165c82728feb51658070c8612d0e7a703;hp=b543c5085e3278b494e501f3c991c1a56ff8d5a1;hb=1b9eec0041fe3ef1066a61937ee8a37cddc6e4a7;hpb=3c13bc0321baaf340663779d6fce2b1f34c1c2c3 diff --git a/INSTALL b/INSTALL index b543c508..4a0dc741 100644 --- a/INSTALL +++ b/INSTALL @@ -20,7 +20,7 @@ configure stage. Dependencies ------------ -Notmuch depends on four libraries: Xapian, GMime 2.4 or 2.6, +Notmuch depends on four libraries: Xapian, GMime 2.6, Talloc, and zlib which are each described below: Xapian @@ -30,7 +30,7 @@ Talloc, and zlib which are each described below: It provides all the real machinery of indexing and searching, (including the very nice parsing of the query string). - Xapian is available from http://xapian.org + Xapian is available from https://xapian.org Note: Notmuch will work best with Xapian 1.0.18 (or later) or Xapian 1.1.4 (or later). Previous versions of Xapian (whether @@ -39,8 +39,8 @@ Talloc, and zlib which are each described below: reading mail while notmuch would wait for Xapian when removing the "inbox" and "unread" tags from messages in a thread. - GMime 2.4 or 2.6 - ---------------- + GMime + ----- GMime provides decoding of MIME email messages for Notmuch. Without GMime, Notmuch would not be able to extract and index @@ -58,7 +58,7 @@ Talloc, and zlib which are each described below: made development of Notmuch much easier and much less prone to memory leaks. - Talloc is available from http://talloc.samba.org/ + Talloc is available from https://talloc.samba.org/ zlib ---- @@ -75,14 +75,11 @@ Talloc, and zlib which are each described below: Building Documentation ---------------------- -By default the documentation for notmuch is built using sphinx. +To build the documentation for notmuch you need at least version 1.0 +of sphinx (Jul. 2010). Sphinx is available from www.sphinx-doc.org. -If you prefer, you can build the man pages using rst2man, from the -python docutils package. See doc/INSTALL for details. - - Installing Dependencies from Packages ------------------------------------- @@ -91,11 +88,11 @@ dependencies with a simple simple command line. For example: For Debian and similar: - sudo apt-get install libxapian-dev libgmime-2.6-dev libtalloc-dev zlib1g-dev python-sphinx + sudo apt-get install libxapian-dev libgmime-3.0-dev libtalloc-dev zlib1g-dev python3-sphinx For Fedora and similar: - sudo yum install xapian-core-devel gmime-devel libtalloc-devel zlib-devel python-sphinx + sudo yum install xapian-core-devel gmime-devel libtalloc-devel zlib-devel python3-sphinx On other systems, a similar command can be used, but the details of the package names may be different.