From 09abee9ebabbd2d316ac41bcdf9de5ef7b5b1355 Mon Sep 17 00:00:00 2001 From: Marshall Lochbaum Date: Sun, 26 Dec 2021 14:49:18 -0500 Subject: Clean up editors introduction and macOS section --- docs/editors/index.html | 14 +++++++++++--- editors/README.md | 17 +++++++++-------- 2 files changed, 20 insertions(+), 11 deletions(-) diff --git a/docs/editors/index.html b/docs/editors/index.html index dca71f04..476da998 100644 --- a/docs/editors/index.html +++ b/docs/editors/index.html @@ -6,13 +6,12 @@
(github) / BQN

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.

+

Editor plugins and other tools for allowing BQN input are in this folder. Input always uses the layout shown here, and is usually performed with a backslash \ prefix, but sometimes with a modifier key such as alt. 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.

-

For macOS, a keyboard layout can be found here.

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!

+

Support for other editors, OSes, or workflows will be gladly accepted!

System-wide

XKB (Unix)

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

@@ -25,6 +24,15 @@

Windows

Folder autohotkey-win contains an AutoHotKey script and the generated .exe file. It runs as an ordinary program that recognizes BQN key combinations system-wide, using the right alt key (to change this, replace RAlt in the script and rebuild). Move it to the startup folder if you'd like to have it running all the time. You can right-click its icon in the system tray to disable it temporarily.

The XCompose file, although created for XKB, is also usable with WinCompose.

+

Mac

+

There are two keyboard layouts: one enables BQN keys with the Alt modifier, and another uses the standard \ prefix.

+

To install:

+ +

Don't use the root-based directory /Library/Keyboard Layouts/ for the first step, as this will silently fail.

Text editors

Vim

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

diff --git a/editors/README.md b/editors/README.md index cb37f013..8bd13e22 100644 --- a/editors/README.md +++ b/editors/README.md @@ -6,7 +6,7 @@ "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. +Editor plugins and other tools for allowing BQN input are in [this folder](https://github.com/mlochbaum/BQN/tree/master/editors). Input always uses the layout shown [here](https://mlochbaum.github.io/BQN/keymap.html), and is usually performed with a backslash `\` prefix, but sometimes with a modifier key such as alt. 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**. @@ -14,11 +14,9 @@ Editor plugins and other tools for allowing BQN input are in [this folder](https For **Android**, [this fork](https://github.com/dzaima/hackerskeyboard/releases/latest) adds APL and BQN to Hacker's Keyboard. -For **macOS**, there are two keyboard layouts: [one](https://github.com/mlochbaum/BQN/blob/master/editors/BQN.keylayout) uses `Alt` key as the modifier, and [another](https://github.com/mlochbaum/BQN/blob/master/editors/BQN_backslash.keylayout) uses `\` prefix key (this layout works similar to BQN vim keymap). - 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! +Support for other editors, OSes, or workflows will be gladly accepted! ## System-wide @@ -42,10 +40,13 @@ The [XCompose](https://github.com/mlochbaum/BQN/blob/master/editors/XCompose) fi ### Mac -Copy the keyboard layout file `BQN.keylayout` to `~/Library/Keyboard Layouts/`. -Navigate to System Preferences > Keyboard > Input Sources > + > Others > BQN. -Restart and then enable the BQN keyboard with System Preferences > Keyboard > Input Sources > BQN US. -Don't copy `BQN.keylayout` directly to `/Library/Keyboard Layouts`, as this will silently fail. +There are two keyboard layouts: [one](https://github.com/mlochbaum/BQN/blob/master/editors/BQN.keylayout) enables BQN keys with the `Alt` modifier, and [another](https://github.com/mlochbaum/BQN/blob/master/editors/BQN_backslash.keylayout) uses the standard `\` prefix. + +To install: +- Copy the appropriate `.keylayout` file to `~/Library/Keyboard Layouts/`. +- Navigate to System Preferences > Keyboard > Input Sources > + > Others > BQN. +- Restart, then enable the BQN keyboard with System Preferences > Keyboard > Input Sources > BQN US. +Don't use the root-based directory `/Library/Keyboard Layouts/` for the first step, as this will silently fail. ## Text editors -- cgit v1.2.3