aboutsummaryrefslogtreecommitdiff
path: root/editors/vim
diff options
context:
space:
mode:
authorMarshall Lochbaum <mwlochbaum@gmail.com>2021-12-07 10:29:29 -0500
committerMarshall Lochbaum <mwlochbaum@gmail.com>2021-12-07 10:29:29 -0500
commitbf8fb1385bdd1339949f9160a5faa689487ee8e4 (patch)
treeb0643a27693c2fdb21fe1b741389b0f3ba2c0871 /editors/vim
parentb9f1ea105f0092a7e89d70f5ae5509e30678d80c (diff)
More vim plugin documentation
Diffstat (limited to 'editors/vim')
-rw-r--r--editors/vim/doc/bqn.txt11
1 files changed, 10 insertions, 1 deletions
diff --git a/editors/vim/doc/bqn.txt b/editors/vim/doc/bqn.txt
index addcebd5..c855b418 100644
--- a/editors/vim/doc/bqn.txt
+++ b/editors/vim/doc/bqn.txt
@@ -11,11 +11,20 @@ for the BQN programming language. For more information
about the language, see
https://mlochbaum.github.io/BQN/
+This plugin also has descriptions of BQN characters:
+press F1 to toggle a status line that describes the
+one under the cursor. While it tries to adjust vim's
+word boundary behavior to match BQN, characters ˜˘˝
+can't be configured and still incorrectly behave as
+word characters.
+
KEYMAP *bqn-keymap*
The plugin sets the following keymap when editing BQN
files, such that the upper symbol is <Leader><key> and
-the lower symbol is <Leader><Shift-key>.
+the lower symbol is <Leader><Shift-key>. The leader
+key defaults to \ and can changed by setting
+g:bqn_prefix_key before loading the keymap.
`˜ 1˘ 2¨ 3⁼ 4⌜ 5´ 6˝ 77 8∞ 9¯ 0• -÷ =×
¬ ⎉ ⚇ ⍟ ◶ ⊘ ⎊ ⍎ ⍕ ⟨ ⟩ √ ⋆