README-elpa (3255B)
1 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2 `CORFU-TERMINAL' - CORFU POPUP ON TERMINAL 3 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 4 5 6 Corfu uses child frames to display candidates. This makes Corfu 7 unusable on terminal. This package replaces that with popup/popon, 8 which works everywhere. 9 10 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 11 GUI Terminal (Colorterm) TTY (with face customizations) 12 ────────────────────────────────────────────────────────────────────────── 13 <./demo-gui.png> <./demo-colorterm.png> <./demo-tty.png> 14 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 15 16 /Note: The above screenshots were taken with `kind-icon' enabled./ /And 17 the TTY screenshot isn't a screenshot of a real TTY, it was/ /emulated 18 on a terminal emulator with `TERM=linux' and `COLORTERM=',/ /and the 19 Corfu faces were modified to make the popup/popon visible on/ /TTY./ 20 21 22 1 Installation 23 ══════════════ 24 25 1.1 Package 26 ─────────── 27 28 Install from NonGNU ELPA. 29 30 31 1.2 Quelpa 32 ────────── 33 34 ┌──── 35 │ (quelpa '(corfu-terminal 36 │ :fetcher git 37 │ :url "https://codeberg.org/akib/emacs-corfu-terminal.git")) 38 └──── 39 40 41 1.3 Straight.el 42 ─────────────── 43 44 ┌──── 45 │ (straight-use-package 46 │ '(corfu-terminal 47 │ :type git 48 │ :repo "https://codeberg.org/akib/emacs-corfu-terminal.git")) 49 └──── 50 51 52 1.4 Manual 53 ────────── 54 55 Download the `corfu-terminal.el' file and put it in your `load-path'. 56 57 58 2 Usage 59 ═══════ 60 61 Enable the global minor mode `M-x corfu-terminal-mode' to enable 62 it. You'll probably want to enable it only on terminal. In that case, 63 put the following in your init file: 64 65 ┌──── 66 │ (unless (display-graphic-p) 67 │ (corfu-terminal-mode +1)) 68 └──── 69 70 71 3 Complementary Packages 72 ════════════════════════ 73 74 • [`kind-icon']: `kind-icon' adds an icon in front of each candidate 75 describing the kind of the candidate. 76 • [`corfu-doc'] and [`corfu-doc-terminal']: `corfu-doc' show a 77 documentation popup for the current candidate. `corfu-doc-terminal' 78 provides a Popon (overlay) based display, so that you can use it on 79 terminal. 80 81 82 [`kind-icon'] <https://github.com/jdtsmith/kind-icon> 83 84 [`corfu-doc'] <https://github.com/galeo/corfu-doc> 85 86 [`corfu-doc-terminal'] 87 <https://codeberg.org/akib/emacs-corfu-doc-terminal>