branch: externals/hotfuzz
commit e07a9404ddd2f9bad314ba740e414871ad55728f
Author: Axel Forsman <[email protected]>
Commit: Axel Forsman <[email protected]>
Add section on related projects
---
README.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++----
1 file changed, 52 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index f685c6c2b7..cb922d775e 100644
--- a/README.md
+++ b/README.md
@@ -12,11 +12,59 @@ or, if using [Selectrum], enable `hotfuzz-selectrum-mode`.
## Customization
-Hotfuzz adheres to a few of the default Emacs completion style
-configuration options:
+Hotfuzz adheres to a few of the default Emacs completion configuration options:
* `completion-ignore-case` specifies whether case should be considered
significant when matching.
* The face `completions-common-part` is used for highlighting the
- characters of a candidate that the search pattern matched.
+ characters of a candidate that the search string matched.
-[Selectrum]: https://github.com/raxod502/selectrum
\ No newline at end of file
+## Related projects
+
+### The `flex` completion style
+
+The `flex` completion style included with Emacs
+does the same matching as hotfuzz, and scores candidates based on gap sizes.
+It does not, however, attempt to find the optimal score.
+For example, given the search string `"foo"`,
+the matched characters in a candidate could look like
+
+> xxx**f**xxx**o**xxx**o**xxxfooxxx
+
+which would score low even though
+there is a contiguous match later in the string.
+
+### flx
+
+The [flx] package - which out-of-the-box only supports [Ido] -
+is a great improvement over `flex`
+that takes into account substring matches and word boundaries.
+However, unlike hotfuzz, other than substring matches,
+it does not try to find the match with the optimal gap arrangement.
+This means that for the search string `"foo"` the candidates
+
+> xxx**f**xxx**o**xxx**o**xxxfxoxoxxxx
+
+and
+
+> xxx**f**xxx**o**xxx**o**xxxxxxxxxxxx
+
+score the same.
+It should be said that this limitation combined with
+the bountiful caching that flx does,
+means that it can be faster at scoring long candidates than hotfuzz.
+
+## orderless
+
+The [orderless] completion style allows
+every component of a space-delimited (by default) pattern
+to match according to any other completion style.
+It is very customizable,
+but does no sorting and allows the individual sub-patterns to overlap
+(`"foo foo"` filters no additional items compared to `"foo"`).
+Hotfuzz on the other hand tries to be more *clever* about sorting,
+and so users who dislike that may prefer orderless.
+
+[Selectrum]: https://github.com/raxod502/selectrum
+[flx]: https://github.com/lewang/flx
+[Ido]: https://www.gnu.org/software/emacs/manual/html_node/ido/index.html
+[orderless]: https://github.com/oantolin/orderless
\ No newline at end of file
