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