diff options
Diffstat (limited to 'editors/README.md')
| -rw-r--r-- | editors/README.md | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/editors/README.md b/editors/README.md index 3f6a6544..2243ffff 100644 --- a/editors/README.md +++ b/editors/README.md @@ -18,9 +18,11 @@ The file [inputrc](https://github.com/mlochbaum/BQN/blob/master/editors/inputrc) If you'd like to contribute files for another editor I'd gladly accept them! -### XKB +## System-wide -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 +### XKB (Unix) + +The file [bqn](https://github.com/mlochbaum/BQN/blob/master/editors/bqn) is for configuring XKB on Linux, or other systems using X11. To use, copy it to `/usr/share/X11/xkb/symbols/`, then run $ setxkbmap -layout us,bqn -option grp:switch @@ -28,6 +30,14 @@ replacing `us` with your ordinary keyboard layout. `switch` indicates the right 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`. +### Windows + +Folder [autohotkey-win](https://github.com/mlochbaum/BQN/tree/master/editors/autohotkey-win) contains an [AutoHotKey](https://en.wikipedia.org/wiki/AutoHotKey) script and the generated .exe file. It runs as an ordinary program that recognizes BQN key combinations system-wide. 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](https://github.com/mlochbaum/BQN/blob/master/editors/XCompose) file, although created for XKB, should also be usable with [WinCompose](https://github.com/samhocevar/wincompose) (but as far as I know this hasn't been tested). + +## Text editors + ### Vim Copy or symlink all files into the corresponding directories in `~/.vim`. Add the following two lines to `~/.vim/filetype.vim`: |