From 3577aec3617540ac58d3ab41e8fa163f75e859b7 Mon Sep 17 00:00:00 2001 From: Marshall Lochbaum Date: Fri, 30 Jul 2021 22:41:17 -0400 Subject: Move editors README to markdown --- docs/editors/index.html | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 docs/editors/index.html (limited to 'docs/editors') diff --git a/docs/editors/index.html b/docs/editors/index.html new file mode 100644 index 00000000..3240ac0a --- /dev/null +++ b/docs/editors/index.html @@ -0,0 +1,33 @@ + + + + BQN: Editor support + +
BQN / main
+

Editor support

+ +

Editor plugins and other tools for allowing BQN input are in this folder. Input is always performed with a backslash \ prefix by default, using the layout shown here. To type an actual backslash, hit the backslash key twice.

+

This bookmarklet enables BQN input in any webpage in your browser.

+

This userscript highlights BQN code on GitHub.

+

For Android, this fork adds APL and BQN to Hacker's Keyboard.

+

The file inputrc can be copied or appended to ~/.inputrc to enable backslash input in bash, BQN with rlwrap, and other software that uses GNU Readline.

+

If you'd like to contribute files for another editor I'd gladly accept them!

+

XKB

+

The file bqn is for configuring XKB on Linux. To use, copy it to /usr/share/X11/xkb/symbols/, then run

+
$ setxkbmap -layout us,bqn -option grp:switch
+
+

replacing us with your ordinary keyboard layout. switch indicates the right alt key and can be replaced with lswitch for left alt or other codes. The setting will go away on shutdown so you will probably want to configure it to run every time you start up. The way to do this depends on your desktop environment. For further discussion, see Wikipedia or the APL Wiki.

+

Another XKB option, if you have a compose key enabled, is to place XCompose (possibly with adjustments) in ~/.XCompose.

+

Vim

+

Copy or symlink all files into the corresponding directories in ~/.vim. Add the following two lines to ~/.vim/filetype.vim:

+
  au! BufRead,BufNewFile *.bqn setf bqn
+  au! BufRead,BufNewFile * if getline(1) =~ '^#!.*bqn$' | setf bqn | endif
+
+

Include syntax on in your .vimrc for syntax highlighting and filetype plugin on for keyboard input.

+

Emacs

+

Add the following two lines to init.el (usually ~/.emacs.d/init.el), replacing the path appropriately.

+
(add-to-list 'load-path "/path/to/BQN/editors/emacs")
+(require 'gnu-apl-mode)
+
+

Kakoune

+

Copy or symlink kak/autoload/filetype/bqn.kak into autoload/filetype in your Kakoune config directory (probably .config/kak/).

-- cgit v1.2.3