fill out README

This commit is contained in:
Jai Flack 2020-09-16 18:30:30 +10:00
父節點 2559132a1b
當前提交 461a252813
簽署人: jflack
GPG 金鑰 ID: 1337AEA30052317F
共有 2 個檔案被更改,包括 22 行新增3 行删除

查看文件

@ -1,3 +0,0 @@
# nnir-mu
mu search backend for Gnus' nnir

22
README.org Normal file
查看文件

@ -0,0 +1,22 @@
#+TITLE: nnir-mu
An mu search backend for Gnus' nnir.
Of course mu is required and must be set up properly for the groups
you want to search. This works almost identically to the current
notmuch engine.
* Enable
To start using it can be as simple as;
#+begin_src emacs-lisp
(add-to-list 'load-path "/path/to/nnir-mu")
(require 'nnir-mu)
;; Then, like any other nnir backend
(custom-set-variables
'(nnir-method-default-engines '((nnmaildir . mu))))
;; or
(setq nnir-method-default-engines '((nnmaildir . mu)))
#+end_src
For configuration options see the header of [[./nnir-mu.el]]