hiro/boon
1
0
Fork 0
mirror of https://github.com/vale981/boon synced 2025-03-05 09:31:43 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
32 commits 1 branch 6 tags 992 KiB
Emacs Lisp 90%
Haskell 6.2%
Nix 3.2%
Makefile 0.6%
Find a file
Jean-Philippe Bernardy 08f7d9acda remove duplicate
2014-10-23 13:37:38 +02:00
.gitignore split code 2014-10-19 13:59:12 +02:00
boon-arguments.el clean 2014-10-23 09:13:57 +02:00
boon-colemak.el c-prefix translation map does not work as planned 2014-10-20 08:40:52 +02:00
boon-core.el add package-menu-mode to speacial modes 2014-10-23 13:35:00 +02:00
boon-extras.el nicification 2014-10-23 13:31:30 +02:00
boon-keys.el should not be in default conf 2014-10-23 13:05:03 +02:00
boon-main.el remove duplicate 2014-10-23 13:37:38 +02:00
boon-pkg.el dep version 2014-10-23 13:07:06 +02:00
boon-search.el bunch of small fixes 2014-10-19 22:29:29 +02:00
boon.el nicification 2014-10-23 13:31:30 +02:00
cheat-sheet.hs initial import 2014-10-18 23:16:06 +02:00
LICENSE Initial commit 2014-10-18 22:03:14 +02:00
README.md readme 2014-10-23 09:54:14 +02:00
todo.org nicification 2014-10-23 13:31:30 +02:00
TUTORIAL.txt nope 2014-10-22 08:47:24 +02:00

README.md

boon: Ergonomic Command Mode for Emacs

What is Boon?

Boon brings modal editing to emacs.

  • Tries to be as comfortable as possible. (See below)
  • Remains lightweight (~300 loc for its core.)
  • Attempt to integrate with emacs as smoothly as possible

Design

It is largely accepted that modal edition is more ergonomic than using keychoord. Boon attempts to make modal editing as comfortable as possible, by adhering to the following design principles:

  • Spacial allocation first, mnemonics second: the allocation of keys to commands is based in priority on the locations of keys on the keyboard. Whatever is printed on the keycap is a secondary concern.

  • Easy finger rolls: common combination should either be left/right hand alternation or easy one-hand rolls.

  • Use of home row and strong fingers for the most used commands

  • Easy navigation: many commands are bound to navigation. This facilitates moving around. Because movements double up as region-definitions, it makes manipulation commands (operators) more powerful.

In command mode, movement keys are bound to the right hand, while text manipulation is bound to the left hand.

Right-hand.

The leftwards (and upwards) movements are bound to the leftmost fingers (index and middle finger), while rightwards (and downwards) movements are bound to the rightmost fingers (ring finger and pinky.) Additional movements are bound to the middle column.

Left-hand.

The most common edition commands (cut, paste, parenthesis manipulation) are bound to the home row. The top row is (mainly) for searching. The bottom row gives access to regular emacs stuff (C-x ...) (C-c ...) and registers.

Installation/Configuration

REQUIREMENTS

  • Emacs version >= 24.3
  • Colemak layout

Install Boon (prehaps using MELPA), and add the following to your configuration:

(require 'boon-colemak) ;; qwerty mode not implemented (contributions welcome) (require 'boon-extras) ;; optional (boon-mode)

Documentation

You can jump-start by reading the cheat sheet directly:

Or go through this modified (and shortened) version of the emacs tutorial:

TUTORIAL.txt

Comparison with other modal layers for emacs

As far as I know, none of the other modal mode care about ergonomics (beside being modal).

  • Evil

In boon, quite a bit of emacs structure and user experience is retained. Examples: the x key gives the C-x prefix map. Interactive arguments are used for text objects.

Besides, Emacs is already customizable enough as it is: the core of Boon is just 200 lines or so. Figuring out all the ins and outs of Evil to do what I want would probably require more effort.

Allows to retain most of emacs. It is similar to "sticky modifier keys" in principle.

Perhaps the work which is the closest to Boon.

Modal Emacs does not appear to be complete.