Add README.org

This commit is contained in:
Jai Flack 2022-03-24 20:10:27 +10:00
parent 99b022bacb
commit ed8861b1c9
No known key found for this signature in database
GPG Key ID: B0073AB365D0807D
1 changed files with 20 additions and 0 deletions

20
README.org Normal file
View File

@ -0,0 +1,20 @@
#+TITLE: isearch-olc
An in-buffer overlay for the current isearch match counts, ~isearch-lazy-count~ but just after the current matches line.
* Enable
This requires both ~isearch-lazy-highlight~ and ~isearch-lazy-count~ to be non-nil. Then simply enable ~isearch-olc-mode~.
For example:
#+begin_src emacs-lisp
(add-to-list 'load-path "/path/to/isearch-olc")
(require 'isearch-olc)
(custom-set-variables
'(isearch-olc-format " [%s/%s]"))
(isearch-olc-mode)
#+end_src
* Configuration
The package currently only exposes one option: ~isearch-olc-format~ which is used to format the result. It is expected to contain two =%s= sequences, the first is replaced with the match number and second the total number of matches.