branch: externals/kind-icon
commit 12aa1a96c9137c4045fc167324b24400b328dc9b
Author: JD Smith <93749+jdtsm...@users.noreply.github.com>
Commit: JD Smith <93749+jdtsm...@users.noreply.github.com>
Mention how to clear cache
---
README.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index d92f9b5..fe33a5c 100644
--- a/README.md
+++ b/README.md
@@ -61,13 +61,13 @@ The configuration defaults should work fine, but kind-icon
can be customized to
### Variables
-`kind-icon` has a few customization variables that allows you to configure its
appearance.
+`kind-icon` has a few customization variables that allows you to configure its
appearance. The easiest way to edit them is `M-x customize-group kind-icon`,
which automatically takes care of cleaning the cache. If you change them
directly from lisp during a session, call `M-x kind-icon-reset-cache` for the
changes to take effect.
**Important configurations:**
-- `kind-icon-use-icons`: If non-nil (the default), prefer icons for prefix
badges. Otherwise, use text labels. Individual kind entries can also have
their icons disabled by removing the `:icon` property in the mapping (see
below).
+- `kind-icon-use-icons`: If non-nil (the default), prefer icons for prefix
badges. Otherwise, use text labels. Individual kind entries can also have
their icons disabled by removing the `:icon` property in the mapping (see
below). If `svg-lib` is unable to download a named icon and it is not cached
on disk, text labels for that kind will be used as a fallback.
-- `kind-icon-mapping`: This is the top level configuration mapping
`:company-kind` "types" like `'variable` and `'function`. Each item in this
list has the format `(sym short-text :keyword value ...)` where `sym` is the
kind (a symbol), and `short-text` is the abbreviated text to display (if icons
are not used). The rest of the list is a property list with optional keys
`:icon` and `:face`. The latter will be used to set the text foreground and
(possibly) background colors on the badg [...]
+- `kind-icon-mapping`: This is the top level configuration mapping
`:company-kind` "types" like `'variable` and `'function`. Each item in this
list has the format `(sym short-text :keyword value ...)` where `sym` is the
kind (a symbol), and `short-text` is the abbreviated text to display (if icons
are not used). The rest of the list is a property list with optional keys
`:icon` and `:face`. The latter will be used to set the text foreground and
(possibly) background colors on the badg [...]
- `kind-icon-default-face`: A face from which the icon background color will
be taken and blended with the `:face` foreground color in the mapping table to
create a custom background color. If not set, the frame default background
color will be used for this purpose. Similarly, the foreground color for this
face, if set, will be used if a `:face` foreground is missing from the mapping.
