diff options
author | Sean Whitton <spwhitton@spwhitton.name> | 2015-12-13 10:29:37 -0700 |
---|---|---|
committer | Sean Whitton <spwhitton@spwhitton.name> | 2018-06-03 19:06:01 +0100 |
commit | 377a96e74e9ab9ee70a245ee0721872d1fe5fb60 (patch) | |
tree | e1f42dd5df980cf432a8fabc7357028aa96c88f7 | |
parent | f5cca15beb845ee26b5168f70017a8c31caa95f8 (diff) |
patch-README
Gbp-Pq: Name 0001-patch-README.patch
-rw-r--r-- | README.md | 50 |
1 files changed, 3 insertions, 47 deletions
@@ -1,5 +1,3 @@ -[![Build Status](https://travis-ci.org/lewang/flx.png)](http://travis-ci.org/lewang/flx) - ## Status This project is more than a year old now. Lots of bugs have been worked out. @@ -8,47 +6,10 @@ It appears some people use it on a regular basis. ## Screencast -[Screencast showing rationale and ido workflow][] +Screencast showing rationale and ido workflow: <http://www.youtube.com/watch?v=_swuJ1RuMgk> ## Installation -### Manual - -Just drop all `.el` files somewhere on your `load-path`. Here's an -example using the folder `~/.emacs.d/vendor`: - -```lisp -(add-to-list 'load-path "~/emacs.d/vendor") -``` - -### Package Repositories - -Available packages: - -- `flx` - matching engine -- `flx-ido` - ido interface for flx - -Install `flx-ido` will pull in `flx` as a dependency. - - -#### [MELPA](http://melpa.milkbox.net) - -If you're an Emacs 24 user or you have a recent version of `package.el` you -can install `flx-ido` from MELPA. - -This version will always be up-to-date. - -#### [Marmalade](http://marmalade-repo.org/) - -`flx-ido` is also available on the Marmalade `package.el` repository. - -### Emacs Prelude - -`flx-ido` is part of the -[Emacs Prelude](https://github.com/bbatsov/prelude). If you're a Prelude -user - `flx-ido` is already properly configured and ready for -action. - ## Usage The sorting algorithm is a balance between word beginnings (abbreviation) and @@ -84,7 +45,8 @@ Matches within the basepath score higher. ## ido support -Add this to your init file and *flx* match will be enabled for ido. +Install the Debian package elpa-flx-ido and add this to your init file +and *flx* match will be enabled for ido. ```lisp (require 'flx-ido) @@ -113,10 +75,6 @@ kick in again. As a point of reference for a 2.3 GHz quad-core i7 processor, a value of `10000` still provides a reasonable completion experience. -- see `flx-ido-big-demo` for example with 36k string (Emacs 24.3). - - - ## Helm support [Helm][] is not supported yet. There is a demo showing how it could work, but I'm @@ -183,6 +141,4 @@ So if you have a modern machine, I encourage you to add the following: to your init file. - -[Screencast showing rationale and ido workflow]: http://www.youtube.com/watch?v=_swuJ1RuMgk [Helm]: https://github.com/emacs-helm/helm |