mirror of
https://github.com/vale981/boon
synced 2025-03-05 17:41:42 -05:00
documentation
This commit is contained in:
parent
8c2fa50009
commit
f8731126cf
3 changed files with 4604 additions and 16 deletions
16
README.md
16
README.md
|
@ -61,21 +61,17 @@ Install Boon (prehaps using
|
||||||
[](http://melpa.org/#/boon)),
|
[](http://melpa.org/#/boon)),
|
||||||
and add the following to your configuration:
|
and add the following to your configuration:
|
||||||
|
|
||||||
(require 'boon-colemak) ;; qwerty mode not implemented (contributions welcome)
|
(require 'boon-colemak) ;; qwerty mode not implemented (contributions welcome)
|
||||||
(require 'boon-extras) ;; optional
|
(require 'boon-extras) ;; optional
|
||||||
(boon-mode)
|
(boon-mode)
|
||||||
|
|
||||||
Documentation
|
You can jump-start by reading the cheat sheet directly (pdf):
|
||||||
-------------
|
|
||||||
|
|
||||||
You can jump-start by reading the cheat sheet directly:
|
|
||||||
|
|
||||||
<link to cheat sheet>
|
<link to cheat sheet>
|
||||||
|
|
||||||
Or go through this modified (and shortened) version of the emacs tutorial:
|
But reading through this modified (and shortened) version of the emacs tutorial is recommended:
|
||||||
|
|
||||||
TUTORIAL.txt
|
|
||||||
|
|
||||||
|
[TUTORIAL](blob/master/TUTORIAL.txt)
|
||||||
|
|
||||||
Comparison with other modal layers for emacs
|
Comparison with other modal layers for emacs
|
||||||
---------------------------------------------
|
---------------------------------------------
|
||||||
|
|
|
@ -168,7 +168,7 @@ argDescs =
|
||||||
,(SearchObject,"A search space")
|
,(SearchObject,"A search space")
|
||||||
,(TextRegion,"A region")
|
,(TextRegion,"A region")
|
||||||
,(Prefix,"(Prefix map)")
|
,(Prefix,"(Prefix map)")
|
||||||
,(Enclosure,"An enclosure")
|
-- ,(Enclosure,"An enclosure")
|
||||||
,(Reserved,"(Reserved key)")]
|
,(Reserved,"(Reserved key)")]
|
||||||
|
|
||||||
legend :: Diagram ()
|
legend :: Diagram ()
|
||||||
|
@ -201,7 +201,9 @@ keyBDiag = do
|
||||||
return ()
|
return ()
|
||||||
|
|
||||||
regDiag = do
|
regDiag = do
|
||||||
|
txt <- mkLabel «Left-hand text region specifiers:»
|
||||||
keys <- matrixDiag (zzipWith keyHalf leftHandK leftHandR)
|
keys <- matrixDiag (zzipWith keyHalf leftHandK leftHandR)
|
||||||
|
spread vdist 7 [keys!!0!!0,txt]
|
||||||
return ()
|
return ()
|
||||||
|
|
||||||
(+++) :: [[a]] -> [[a]] -> [[a]]
|
(+++) :: [[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:
|
Command mode bindings:
|
||||||
@keyBDiag
|
@keyBDiag
|
||||||
|
|
||||||
Left-hand text region specifiers:
|
@vspace"1em"
|
||||||
@regDiag
|
@regDiag @hfill @legend
|
||||||
@cmd0"newpage"
|
|
||||||
The color of a key indicates the argument(s) it takes.
|
|
||||||
@legend
|
|
||||||
»
|
»
|
||||||
|
|
||||||
|
|
4593
cheat-sheet.svg
Normal file
4593
cheat-sheet.svg
Normal file
File diff suppressed because it is too large
Load diff
After Width: | Height: | Size: 260 KiB |
Loading…
Add table
Reference in a new issue