branch: elpa/isl
commit 18974efe2a702494cd77690aa7d15c54a13d7b9b
Author: Thierry Volpiatto <[email protected]>
Commit: Thierry Volpiatto <[email protected]>
Update README
---
README.org | 38 +++++++++++++++++---------------------
1 file changed, 17 insertions(+), 21 deletions(-)
diff --git a/README.org b/README.org
index 8c6942844d4..1601c37c0fb 100644
--- a/README.org
+++ b/README.org
@@ -1,25 +1,26 @@
-* Isearch-light :TOC:
+* Isl :TOC:
- [[#introduction][Introduction]]
- [[#features][Features]]
- [[#dependencies][Dependencies]]
- - [[#namespace][Namespace]]
- [[#install][install]]
+ - [[#from-package][From package]]
- [[#from-source][From source]]
- [[#configure][Configure]]
- [[#usage][Usage]]
- [[#available-commands][Available commands]]
- [[#about-multi-matching][About multi matching]]
- - [[#isearch-light-vs-helm-occur][Isearch-light vs helm-occur]]
- - [[#use-isearch-light-for-helm-help][Use isearch-light for helm-help]]
+ - [[#isl-vs-helm-occur][Isl vs helm-occur]]
+ - [[#use-isl-for-helm-help][Use Isl for helm-help]]
** Introduction
+Isl like Isearch-light.
An Isearch replacement for Emacs.
Multi search expression(s) in symbols, words and/or lines in ~current-buffer~.
** Features
-- Provide
[[https://github.com/thierryvolpiatto/isearch-light?tab=readme-ov-file#about-multi-matching][multi
matching]], a real minibuffer, no unexpected quit or
+- Provide [[https://github.com/thierryvolpiatto/isl
?tab=readme-ov-file#about-multi-matching][multi matching]], a real minibuffer,
no unexpected quit or
errors and comprehensive mode-line indicators.
- Old position is always saved in mark-ring when exiting to a new place.
@@ -51,16 +52,12 @@ have =helm-occur=,
[[https://github.com/victorhge/iedit][Iedit]] to allow jumpin
mark interesting positions while navigating (if you use this you will
want as well [[https://github.com/emacs-helm/helm-bm][helm-bm]] to retrieve
later these positions).
-** Namespace
+** Install
-The name of the package is Isearch-light but the lisp file is named
-isl.el and all symbols are prefixed with "isl-". For now it is ok like
-this especially because it is not packaged in (M)Elpa. If any
-conflicts would happen in the future I may rename package, file and symbols.
+*** From package
-** install
-
-No installation from (M)Elpa and package.el is provided for now.
+Isl is available in NonGnu Elpa.
+Use =package-install= to install it.
*** From source
@@ -116,7 +113,7 @@ tell you the style of search you are using. Case
sensitivity in use is
notified by ~*~, ~0~ or ~1~ which mean smart, nil or t for =case-fold-search=.
Don't forget =C-h m= which show you all these commands while
-running isearch-light.
+running Isl.
NOTE: Another map =isl-mini-map= is used when excuting-kbd-macro, you may
want to modify it accordingly to fit with =isl-map=.
@@ -172,25 +169,24 @@ Note: You can jump to =helm-occur= for a line based
search at any time.
You can also jump to [[https://github.com/victorhge/iedit][iedit-mode]] with
multi match pattern (you may have
an error if all the matches do not refer to the same word or symbol).
-** Isearch-light vs helm-occur
+** Isl vs helm-occur
-Isearch-light is a good tool for searching words or symbols in a
+Isl is a good tool for searching words or symbols in a
buffer and even if it can search several words separated by spaces,
helm-occur is more efficient for this as it is based on line searching.
Helm-occur is not efficient when you have to search in a buffer with
continuous text with no newlines e.g. some logs or debug logs
-etc... you have better time using isearch-light.
+etc... you have better time using isl.
-A good compromise is to start searching with isearch-light and if it
+A good compromise is to start searching with isl and if it
turns out what you need to match is whole lines instead of words or
symbols, switch to helm-occur with =isl-jump-to-helm-occur= bound by
default to =M-s=.
-UPDATE: Isearch-light can now switch to a line based search like
-=helm-occur= easily.
+UPDATE: Isl can now switch to a line based search like =helm-occur= easily.
-** Use isearch-light for helm-help
+** Use Isl for helm-help
Starting from Emacs-27 Isearch works more or less with unexpected
effects, you have better time using =isl-search= as the search command for
