[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/vertico f835fb6 14/48: add readme
From: |
Stefan Monnier |
Subject: |
[elpa] externals/vertico f835fb6 14/48: add readme |
Date: |
Mon, 5 Apr 2021 10:54:41 -0400 (EDT) |
branch: externals/vertico
commit f835fb6c79cb5835caa45375eb229af759ad78ef
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>
add readme
---
README.org | 28 ++++++++++++++++++++++++++++
1 file changed, 28 insertions(+)
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..8873908
--- /dev/null
+++ b/README.org
@@ -0,0 +1,28 @@
+#+title: minicomp.el - Minimal vertical completion system
+#+author: Daniel Mendler
+#+language: en
+
+* Introduction
+
+This package provides a minimal vertical completion system, which is based on
+the default completion system. By reusing the default system, we achieve full
+compatibility with built-in Emacs commands and completion tables. The
completion
+system is pretty bare-bone and only provides a minimal set of commands. The
code
+base is less than 500 lines of code. If you are looking for a more
full-featured
+package, you may be interested in
[[https://github.com/raxod502/selectrum][Selectrum]]. Selectrum supports
Avy-style
+selection keys, a horizontal display and a buffer display.
+
+Complementary packages, which are supported:
+
+- [[https://github.com/minad/marginalia][Marginalia]]: Annotations in the
Minibuffer
+- [[https://github.com/minad/consult][Consult]]: Many useful search and
navigation commands
+- [[https://github.com/oantolin/embark][Embark]]: Minibuffer actions and
context menu
+- [[https://github.com/oantolin/orderless][Orderless]]: Advanced completion
style
+
+* Configuration
+
+#+begin_src emacs-lisp
+(use-package minicomp
+ :init
+ (minicomp-mode))
+#+end_src
- [elpa] externals/vertico 245944a 21/48: remap previous/next-line, (continued)
- [elpa] externals/vertico 245944a 21/48: remap previous/next-line, Stefan Monnier, 2021/04/05
- [elpa] externals/vertico 7fbaeaf 15/48: Add sorting by history for files, Stefan Monnier, 2021/04/05
- [elpa] externals/vertico c2bfea2 17/48: use candidate returned from affixation function, Stefan Monnier, 2021/04/05
- [elpa] externals/vertico bafee15 19/48: add minicomp-exit-input, Stefan Monnier, 2021/04/05
- [elpa] externals/vertico e8a3e96 16/48: Minor optimization, Stefan Monnier, 2021/04/05
- [elpa] externals/vertico 333a0a2 29/48: use chunks for candidate formatting, Stefan Monnier, 2021/04/05
- [elpa] externals/vertico 8b760bc 30/48: Fix minicomp--index initialization, Stefan Monnier, 2021/04/05
- [elpa] externals/vertico ed87a60 33/48: Require 27.1, Stefan Monnier, 2021/04/05
- [elpa] externals/vertico c4b3e8b 42/48: Simplify minicomp--flatten-prop, Stefan Monnier, 2021/04/05
- [elpa] externals/vertico 99a355c 12/48: abort minibuffer session if while-no-input returns nil, Stefan Monnier, 2021/04/05
- [elpa] externals/vertico f835fb6 14/48: add readme,
Stefan Monnier <=
- [elpa] externals/vertico 1b75916 18/48: better orderless integration, Stefan Monnier, 2021/04/05
- [elpa] externals/vertico 42823ce 25/48: Use read-char-exclusive to avoid error message, Stefan Monnier, 2021/04/05
- [elpa] externals/vertico af41b13 24/48: fix lexical scoping, Stefan Monnier, 2021/04/05
- [elpa] externals/vertico fa9e8dc 26/48: split functions, Stefan Monnier, 2021/04/05
- [elpa] externals/vertico 27070bb 27/48: truncate long candidate strings, Stefan Monnier, 2021/04/05
- [elpa] externals/vertico 94d9c4c 28/48: use literals, Stefan Monnier, 2021/04/05
- [elpa] externals/vertico 5f64f97 22/48: update readme, Stefan Monnier, 2021/04/05
- [elpa] externals/vertico 308670c 31/48: Fix confirmation: Use ignore-errors+read-char, Stefan Monnier, 2021/04/05
- [elpa] externals/vertico 2cde6fd 40/48: Simplify, Stefan Monnier, 2021/04/05
- [elpa] externals/vertico e429e06 43/48: Rename to vertico, Stefan Monnier, 2021/04/05