documentation

This commit is contained in:
Jean-Philippe Bernardy 2014-10-24 22:40:05 +02:00
parent 8c2fa50009
commit f8731126cf
3 changed files with 4604 additions and 16 deletions

View file

@ -61,21 +61,17 @@ Install Boon (prehaps using
[![MELPA](http://melpa.org/packages/boon-badge.svg)](http://melpa.org/#/boon)),
and add the following to your configuration:
(require 'boon-colemak) ;; qwerty mode not implemented (contributions welcome)
(require 'boon-extras) ;; optional
(boon-mode)
(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:
You can jump-start by reading the cheat sheet directly (pdf):
<link to cheat sheet>
Or go through this modified (and shortened) version of the emacs tutorial:
TUTORIAL.txt
But reading through this modified (and shortened) version of the emacs tutorial is recommended:
[TUTORIAL](blob/master/TUTORIAL.txt)
Comparison with other modal layers for emacs
---------------------------------------------

View file

@ -168,7 +168,7 @@ argDescs =
,(SearchObject,"A search space")
,(TextRegion,"A region")
,(Prefix,"(Prefix map)")
,(Enclosure,"An enclosure")
-- ,(Enclosure,"An enclosure")
,(Reserved,"(Reserved key)")]
legend :: Diagram ()
@ -201,7 +201,9 @@ keyBDiag = do
return ()
regDiag = do
txt <- mkLabel «Left-hand text region specifiers:»
keys <- matrixDiag (zzipWith keyHalf leftHandK leftHandR)
spread vdist 7 [keys!!0!!0,txt]
return ()
(+++) :: [[a]] -> [[a]] -> [[a]]
@ -217,10 +219,7 @@ BOON cheat sheet. It is recommended to read the TUTORIAL to make sense of this.
Command mode bindings:
@keyBDiag
Left-hand text region specifiers:
@regDiag
@cmd0"newpage"
The color of a key indicates the argument(s) it takes.
@legend
@vspace"1em"
@regDiag @hfill @legend
»

4593
cheat-sheet.svg Normal file

File diff suppressed because it is too large Load diff

After

Width:  |  Height:  |  Size: 260 KiB