diff options
| -rw-r--r-- | docs/editors/index.html | 14 | ||||
| -rw-r--r-- | 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 @@ <div class="nav">(<a href="https://github.com/mlochbaum/BQN">github</a>) / <a href="../index.html">BQN</a></div> <h1 id="editor-support"><a class="header" href="#editor-support">Editor support</a></h1> <style>.Comment,.Function,.Number,.String { color: inherit; }</style> -<p>Editor plugins and other tools for allowing BQN input are in <a href="https://github.com/mlochbaum/BQN/tree/master/editors">this folder</a>. Input is always performed with a backslash <code><span class='Value'>\</span></code> prefix by default, using the layout shown <a href="https://mlochbaum.github.io/BQN/keymap.html">here</a>. To type an actual backslash, hit the backslash key twice.</p> +<p>Editor plugins and other tools for allowing BQN input are in <a href="https://github.com/mlochbaum/BQN/tree/master/editors">this folder</a>. Input always uses the layout shown <a href="https://mlochbaum.github.io/BQN/keymap.html">here</a>, and is usually performed with a backslash <code><span class='Value'>\</span></code> prefix, but sometimes with a modifier key such as alt. To type an actual backslash, hit the backslash key twice.</p> <p><a href="https://abrudz.github.io/lb/bqn">This bookmarklet</a> enables BQN input in any webpage in your <strong>browser</strong>.</p> <p><a href="https://gist.github.com/dzaima/35ca0ce12b5e215a62460f00e693984f">This userscript</a> highlights BQN code on <strong>GitHub</strong>.</p> <p>For <strong>Android</strong>, <a href="https://github.com/dzaima/hackerskeyboard/releases/latest">this fork</a> adds APL and BQN to Hacker's Keyboard.</p> -<p>For <strong>macOS</strong>, a keyboard layout can be found <a href="https://github.com/mlochbaum/BQN/blob/master/editors/BQN.keylayout">here</a>.</p> <p>The file <a href="https://github.com/mlochbaum/BQN/blob/master/editors/inputrc">inputrc</a> can be copied or appended to <code><span class='Value'>~</span><span class='Function'>/</span><span class='Value'>.inputrc</span></code> to enable backslash input in <strong>bash</strong>, BQN with <strong>rlwrap</strong>, and other software that uses GNU Readline.</p> -<p>If you'd like to contribute files for another editor I'd gladly accept them!</p> +<p>Support for other editors, OSes, or workflows will be gladly accepted!</p> <h2 id="system-wide"><a class="header" href="#system-wide">System-wide</a></h2> <h3 id="xkb-unix"><a class="header" href="#xkb-unix">XKB (Unix)</a></h3> <p>The file <a href="https://github.com/mlochbaum/BQN/blob/master/editors/bqn">bqn</a> is for configuring XKB on Linux, or other systems using X11. To use, copy it to <code><span class='Function'>/</span><span class='Value'>usr</span><span class='Function'>/</span><span class='Value'>share</span><span class='Function'>/X11/</span><span class='Value'>xkb</span><span class='Function'>/</span><span class='Value'>symbols</span><span class='Function'>/</span></code>, then run</p> @@ -25,6 +24,15 @@ <h3 id="windows"><a class="header" href="#windows">Windows</a></h3> <p>Folder <a href="https://github.com/mlochbaum/BQN/tree/master/editors/autohotkey-win">autohotkey-win</a> contains an <a href="https://en.wikipedia.org/wiki/AutoHotKey">AutoHotKey</a> 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 <code><span class='Function'>RAlt</span></code> 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.</p> <p>The <a href="https://github.com/mlochbaum/BQN/blob/master/editors/XCompose">XCompose</a> file, although created for XKB, is also usable with <a href="https://github.com/samhocevar/wincompose">WinCompose</a>.</p> +<h3 id="mac"><a class="header" href="#mac">Mac</a></h3> +<p>There are two keyboard layouts: <a href="https://github.com/mlochbaum/BQN/blob/master/editors/BQN.keylayout">one</a> enables BQN keys with the <code><span class='Function'>Alt</span></code> modifier, and <a href="https://github.com/mlochbaum/BQN/blob/master/editors/BQN_backslash.keylayout">another</a> uses the standard <code><span class='Value'>\</span></code> prefix.</p> +<p>To install:</p> +<ul> +<li>Copy the appropriate <code><span class='Value'>.keylayout</span></code> file to <code><span class='Value'>~</span><span class='Function'>/Library/Keyboard</span> <span class='Function'>Layouts/</span></code>.</li> +<li>Navigate to System Preferences > Keyboard > Input Sources > + > Others > BQN.</li> +<li>Restart, then enable the BQN keyboard with System Preferences > Keyboard > Input Sources > BQN US.</li> +</ul> +<p>Don't use the root-based directory <code><span class='Function'>/Library/Keyboard</span> <span class='Function'>Layouts/</span></code> for the first step, as this will silently fail.</p> <h2 id="text-editors"><a class="header" href="#text-editors">Text editors</a></h2> <h3 id="vim"><a class="header" href="#vim">Vim</a></h3> <p>Copy or symlink all files into the corresponding directories in <code><span class='Value'>~</span><span class='Function'>/</span><span class='Value'>.vim</span></code>. Add the following two lines to <code><span class='Value'>~</span><span class='Function'>/</span><span class='Value'>.vim</span><span class='Function'>/</span><span class='Value'>filetype.vim</span></code>:</p> 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 |