a vim plugin that displays stuff on an led matrix
dunkirk.sh
1# Braille Typing Indicator Plugin for Neovim
2
3A simple plugin that displays a random Braille character in your statusline that changes every time you type.
4
5## Installation
6
7### Using a plugin manager (recommended)
8
9#### [packer.nvim](https://github.com/wbthomason/packer.nvim)
10
11```lua
12use {
13 'taciturnaxolotl/daedalus',
14 config = function()
15 require('braille_indicator').setup()
16 end
17}
18```
19
20#### [lazy.nvim](https://github.com/folke/lazy.nvim)
21
22```lua
23{
24 'taciturnaxolotl/daedalus',
25 config = function()
26 require('braille_indicator').setup()
27 end
28}
29```
30
31### Manual installation
32
331. Clone this repository to your Neovim configuration directory:
34
35 ```
36 git clone https://github.com/taciturnaxolotl/daedalus.git ~/.config/nvim/pack/plugins/start/daedalus
37 ```
38
392. Add the following to your `init.lua`:
40 ```lua
41 require('braille_indicator').setup()
42 ```
43
44## Configuration
45
46The plugin works with minimal configuration, but you can customize it:
47
48```lua
49require('braille_indicator').setup({
50 update_statusline = true, -- Automatically update the statusline
51 verbose = true, -- Show setup messages
52})
53```
54
55### Adding to your statusline
56
57If you're using a custom statusline setup, add the Braille indicator with:
58
59```lua
60%{v:lua.getBrailleIndicator()}
61```
62
63For example, with lualine:
64
65```lua
66require('lualine').setup({
67 sections = {
68 lualine_a = {
69 function()
70 return getBrailleIndicator()
71 end,
72 'mode'
73 },
74 -- other sections...
75 }
76})
77```
78