fill out README

Este commit está contenido en:
Jai Flack 2020-09-16 18:30:30 +10:00
padre 2559132a1b
commit 461a252813
Firmado por: jflack
ID de clave GPG: 1337AEA30052317F
Se han modificado 2 ficheros con 22 adiciones y 3 borrados

Ver fichero

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

22
README.org Archivo normal
Ver fichero

@ -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]]