branch: externals/mct
commit 2005c02bd66d616bcf675f0e1e9ed8682ef2a99b
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Update the description of the package
---
README.md | 27 ++++++++++++++++++++++-----
README.org | 32 +++++++++++++++++++-------------
mct.el | 27 ++++++++++++++++++++++-----
3 files changed, 63 insertions(+), 23 deletions(-)
diff --git a/README.md b/README.md
index 8f4f43e30b..d203efcd79 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,27 @@
# Minibuffer Confines Transcended (mct.el)
-Enhancements for the default minibuffer completion UI of Emacs. In
-essence, MCT is (i) a very thin layer of interactivity on top of the
-out-of-the-box completion experience, and (ii) glue code that combines
-built-in functionalities to make the default completion framework work
-like that of more featureful third-party options.
+Opinionated changes and enhancements to the default minibuffer
+completion UI of Emacs:
+
+- Live completions to update the results as you type.
+
+- Passlist and blocklist of commands or completion categories to
+ control whether the `*Completions*` buffer shows up eagerly.
+
+- Other relevant options to control when the `*Completions*` are
+ displayed.
+
+- Per command or completion category sorting methods.
+
+- A cleaner `*Completions*` buffer, optionally without a mode line.
+
+- Commands to cycle from the minibuffer to the `*Completions*` and
+ vice versa.
+
+In essence, MCT is (i) a layer of interactivity on top of the
+out-of-the-box completion experience, and (ii) glue code that
+combines built-in functionalities to make the default completion
+framework work like that of more featureful third-party options.
+ Package name (GNU ELPA): `mct`
+ Official manual: <https://protesilaos.com/emacs/mct>
diff --git a/README.org b/README.org
index e9bd5274f3..3df01f72dd 100644
--- a/README.org
+++ b/README.org
@@ -72,23 +72,29 @@ modify this GNU manual.”
:END:
#+cindex: Overview of features
-Minibuffer and Completions in Tandem, also known as "MCT", "Mct", =mct=,
-or =mct.el=, is a package that enhances the default minibuffer and
-=*Completions*= buffer of Emacs 28 (or higher) so that they work together
-as part of a unified framework. The idea is to make the presentation
-and overall functionality be consistent with other popular, vertically
-aligned completion UIs while leveraging built-in functionality.
-
-The main feature set that unifies the minibuffer and the =*Completions*=
-buffer consists of commands that cycle between the two, making it seem
-like they are part of a contiguous space
([[#h:884d6702-8666-4d89-87a2-7d74843653f3][Basic usage]]).
+Minibuffer and Completions in Tandem, also known as "MCT", "Mct",
+=mct=, or =mct.el=, is a package that enhances the default minibuffer
+and =*Completions*= buffer of Emacs 29 (or higher) so that they work
+together as part of a unified framework. The idea is to make the
+presentation and overall functionality be consistent with other
+popular, vertically aligned completion UIs while leveraging built-in
+functionality.
+
+The main feature set that unifies the minibuffer and the
+=*Completions*= buffer consists of commands that cycle between the
+two, making it seem like they are part of a contiguous space
([[#h:884d6702-8666-4d89-87a2-7d74843653f3][Basic usage]]).
MCT tries to find a middle ground between the frugal defaults and the
-more opinionated completion UIs. This is most evident in its approach
-on how to present completion candidates. Instead of showing them
+more opinionated completion UIs. This is most evident in its approach
+on how to present completion candidates. Instead of showing them
outright or only displaying them on demand, MCT implements a minimum
input threshold as well as a slight delay before it pops up the
-=*Completions*= buffer and starts updating it to respond to user input.
+=*Completions*= buffer and starts updating it to respond to user
+input. Additionally, it has user options to control when the
+=*Completions*= appear, including a passlist and a blocklist:
+
+- [[#h:334abfc2-85ce-4519-add5-5a3775dd5e12][Passlist for commands or
completion categories]]
+- [[#h:36f56245-281a-4389-a998-66778de100db][Blocklist for commands or
completion categories]]
* Customizations
:PROPERTIES:
diff --git a/mct.el b/mct.el
index a41a4c57ea..f073fe5611 100644
--- a/mct.el
+++ b/mct.el
@@ -25,11 +25,28 @@
;;; Commentary:
;;
-;; Enhancements for the default minibuffer completion UI of Emacs. In
-;; essence, MCT is (i) a very thin layer of interactivity on top of the
-;; out-of-the-box completion experience, and (ii) glue code that combines
-;; built-in functionalities to make the default completion framework work
-;; like that of more featureful third-party options.
+;; Opinionated changes and enhancements to the default minibuffer
+;; completion UI of Emacs:
+;;
+;; - Live completions to update the results as you type.
+;;
+;; - Passlist and blocklist of commands or completion categories to
+;; control whether the *Completions* buffer shows up eagerly.
+;;
+;; - Other relevant options to control when the *Completions* are
+;; displayed.
+;;
+;; - Per command or completion category sorting methods.
+;;
+;; - A cleaner *Completions* buffer, optionally without a mode line.
+;;
+;; - Commands to cycle from the minibuffer to the *Completions* and
+;; vice versa.
+;;
+;; In essence, MCT is (i) a layer of interactivity on top of the
+;; out-of-the-box completion experience, and (ii) glue code that
+;; combines built-in functionalities to make the default completion
+;; framework work like that of more featureful third-party options.
;;; Code:
