aboutsummaryrefslogtreecommitdiff
path: root/editors
diff options
context:
space:
mode:
authorMarshall Lochbaum <mwlochbaum@gmail.com>2021-07-30 22:41:17 -0400
committerMarshall Lochbaum <mwlochbaum@gmail.com>2021-07-31 16:49:50 -0400
commit3577aec3617540ac58d3ab41e8fa163f75e859b7 (patch)
tree411f32412418d66e961d73a11519ee334ef6288e /editors
parentf9925688329fb02b46e524cd31ac733f37549eeb (diff)
Move editors README to markdown
Diffstat (limited to 'editors')
-rw-r--r--editors/README.md49
-rw-r--r--editors/README.txt49
2 files changed, 49 insertions, 49 deletions
diff --git a/editors/README.md b/editors/README.md
new file mode 100644
index 00000000..0c77d184
--- /dev/null
+++ b/editors/README.md
@@ -0,0 +1,49 @@
+*View this file with results and syntax highlighting [here](https://mlochbaum.github.io/BQN/editors/index.html).*
+
+# Editor support
+
+<!--GEN
+"style" Enc ".Comment,.Function,.Number,.String { color: inherit; }"
+-->
+
+Editor plugins and other tools for allowing BQN input are in [this folder](https://github.com/mlochbaum/BQN/tree/master/editors). Input is always performed with a backslash `\` prefix by default, using the layout shown [here](https://mlochbaum.github.io/BQN/keymap.html). To type an actual backslash, hit the backslash key twice.
+
+[This bookmarklet](https://abrudz.github.io/lb/bqn) enables BQN input in any webpage in your **browser**.
+
+[This userscript](https://gist.github.com/dzaima/35ca0ce12b5e215a62460f00e693984f) highlights BQN code on **GitHub**.
+
+For **Android**, [this fork](https://github.com/dzaima/hackerskeyboard/releases/latest) adds APL and BQN to Hacker's Keyboard.
+
+The file [inputrc](https://github.com/mlochbaum/BQN/blob/master/editors/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](https://github.com/mlochbaum/BQN/blob/master/editors/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](https://en.wikipedia.org/wiki/X_keyboard_extension) or the [APL Wiki](https://aplwiki.com/wiki/Typing_glyphs_on_Linux).
+
+Another XKB option, if you have a compose key enabled, is to place [XCompose](https://github.com/mlochbaum/BQN/blob/master/editors/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/`).
diff --git a/editors/README.txt b/editors/README.txt
deleted file mode 100644
index a75d5ad6..00000000
--- a/editors/README.txt
+++ /dev/null
@@ -1,49 +0,0 @@
-Editor plugins and other tools for allowing BQN input. Input is always
-performed with a backslash prefix by default, using the layout
-illustrated at the top of the file ./bqn . To type an actual backslash,
-hit the backslash key twice.
-
-External userscript for highlighting BQN code on GitHub:
-https://gist.github.com/dzaima/35ca0ce12b5e215a62460f00e693984f
-
-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:
-- https://en.wikipedia.org/wiki/X_keyboard_extension
-- https://aplwiki.com/wiki/Typing_glyphs_on_Linux
-
-Another XKB option, if you have a compose key enabled, is to place
-XCompose (possibly with adjustments) in ~/.XCompose .
-
-For Android, the following fork adds APL and BQN to Hacker's Keyboard:
-https://github.com/dzaima/hackerskeyboard/releases/latest
-
-The file inputrc can be copied or appended to ~/.inputrc to enable
-backslash input in bash, command-line dzaima/BQN, and other software
-that uses GNU Readline.
-
-For 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.
-
-For 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)
-
-For Kakoune:
-Copy or symlink kak/autoload/filetype/bqn.kak into autoload/filetype in
-your Kakoune config directory (probably .config/kak/).
-
-If you'd like to contribute files for another editor I'd gladly accept
-them!