[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/kind-icon 5defd86 23/51: Clean up install info
From: |
ELPA Syncer |
Subject: |
[elpa] externals/kind-icon 5defd86 23/51: Clean up install info |
Date: |
Wed, 17 Nov 2021 15:57:43 -0500 (EST) |
branch: externals/kind-icon
commit 5defd8695ee92bf16caaa4a99649177bd982f194
Author: JD Smith <93749+jdtsmith@users.noreply.github.com>
Commit: JD Smith <93749+jdtsmith@users.noreply.github.com>
Clean up install info
---
README.md | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index aacae14..f6ac419 100644
--- a/README.md
+++ b/README.md
@@ -23,7 +23,11 @@ A few examples of `kind-icon` in action:
## Installation
-Get it from melpa (TBD), which should install `svg-lib` as well if necessary.
Enable in any buffer with completion using `kind-icon-mode`. E.g., to enable
for the completion UI [corfu](https://github.com/minad/corfu), which has a
kind-formatter configuration:
+Get it from melpa (TBD). Note that icons support requires
[svg-lib](https://github.com/rougier/svg-lib). At present `kind-icon` has been
tested extensively with [corfu](https://github.com/minad/corfu).
+
+### Using kind-formatter:
+
+To enable for the completion UI [corfu](https://github.com/minad/corfu), which
has a kind-formatter configuration:
```elisp
(use-package kind-icon ;package availability TBD
@@ -34,6 +38,8 @@ Get it from melpa (TBD), which should install `svg-lib` as
well if necessary. E
(corfu-kind-formatter #'kind-icon-formatted))
```
+### Wrapping completion-in-region
+
The more generic approach of wrapping the `completion-in-region-function`
would look like:
```elisp
@@ -47,6 +53,8 @@ The more generic approach of wrapping the
`completion-in-region-function` would
completion-in-region-function)))))
```
+For whichever completion-ui you are using.
+
## Configuration
The configuration defaults should work fine, but kind-icon can be customized
to change the colors, preference of icons vs. short-text (or mixed) prefixes,
and more.
- [elpa] externals/kind-icon 12aa1a9 42/51: Mention how to clear cache, (continued)
- [elpa] externals/kind-icon 12aa1a9 42/51: Mention how to clear cache, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 8087c8e 44/51: Update README.md, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon ba37562 09/51: more docs, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon f080f3d 15/51: Remove minor mode in favor of c-in-r-f wrapper function, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon b88965b 28/51: Update README.md, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon ab3c6d5 24/51: Expand material icon description and mention text-based icons, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 5bf075d 16/51: Add some two character short-text codes, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon e4d941b 45/51: Update README.md, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 3746bd4 43/51: Fix function name typo, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 4b3a770 51/51: Update README.md, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 5defd86 23/51: Clean up install info,
ELPA Syncer <=
- [elpa] externals/kind-icon 15de78d 22/51: Update README.md, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon ec8b77e 25/51: Update README.md, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 51f77db 50/51: Update README.md, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 1ec82fc 29/51: Update README.md, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon 77ad2b4 39/51: Affixation and download warning, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon ad66cbe 26/51: Update README.md, ELPA Syncer, 2021/11/17
- [elpa] externals/kind-icon c57ad9d 41/51: Update README.md, ELPA Syncer, 2021/11/17