branch: elpa/xah-fly-keys
commit cb2b27ed7566b7863ad3e9adf67d75945d4118b0
Author: Xah Lee <x...@xahlee.org>
Commit: Xah Lee <x...@xahlee.org>
more format change and better readme
---
README.md | 53 +++++++++++++++++++++++-------------------
xah-fly-keys.el | 71 +++++++++++++++++++++++++++++++++++++--------------------
2 files changed, 75 insertions(+), 49 deletions(-)
diff --git a/README.md b/README.md
index 05aabee6c8..5a59af0f55 100755
--- a/README.md
+++ b/README.md
@@ -13,43 +13,48 @@ http://ergoemacs.org/misc/ergoemacs_vi_mode.html
Major key engine rewrite by Dan Langlois (https://github.com/DanLanglois) and
Will Dey (https://github.com/wi11dey) .
-The old stable version is available at
-http://ergoemacs.org/misc/i/xah-fly-keys_old_2020-04-18.el
-
QWERTY layout
-------------------
-Documentation
+Manual Install
-------------------
-Add the following to `.emacs` after installing manually or via MELPA:
+put the file xah-fly-keys.el in ~/.emacs.d/lisp/
+create the dir if doesn't exist.
+
+put the following in your emacs init file:
+
```elisp
+(add-to-list 'load-path "~/.emacs.d/lisp/")
(require 'xah-fly-keys)
(xah-fly-keys-set-layout "qwerty") ; required
```
The following keyboard layouts are supported:
-* "azerty"
-* "azerty-be"
-* "colemak"
-* "colemak-mod-dh"
-* "colemak-mod-dh-new"
-* "dvorak"
-* "programer-dvorak"
-* "qwerty"
-* "qwerty-abnt"
-* "qwertz"
-* "workman"
-* "norman"
-* ["neo2"](https://neo-layout.org/)
-* "koy"
-* "adnw"
-* "pt-nativo"
-* "carpalx-qgmlwy"
-* "carpalx-qgmlwb"
-* "carpalx-qfmlwy"
+* adnw
+* azerty
+* azerty-be
+* beopy
+* bepo
+* carpalx-qfmlwy
+* carpalx-qgmlwb
+* carpalx-qgmlwy
+* colemak
+* colemak-mod-dh
+* colemak-mod-dh-new
+* dvorak
+* koy
+* neo2
+* norman
+* programer-dvorak
+* pt-nativo
+* qwerty
+* qwerty-abnt
+* qwerty-no (qwerty Norwegian)
+* qwertz
+* workman
Full Documentation
-------------------
diff --git a/xah-fly-keys.el b/xah-fly-keys.el
index 04b52d637c..3b43ca26c4 100644
--- a/xah-fly-keys.el
+++ b/xah-fly-keys.el
@@ -3,7 +3,7 @@
;; Copyright © 2013-2022 by Xah Lee
;; Author: Xah Lee ( http://xahlee.info/ )
-;; Version: 17.5.20220415142016
+;; Version: 17.5.20220416101054
;; Created: 10 Sep 2013
;; Package-Requires: ((emacs "24.1"))
;; Keywords: convenience, emulations, vim, ergoemacs
@@ -14,7 +14,9 @@
;;; Commentary:
-;; xah-fly-keys is a efficient keybinding for emacs. It is modal like vi, but
key choices are based on statistics of command call frequency.
+;; xah-fly-keys is a efficient keybinding for emacs. It is modal like
+;; vi, but key choices are based on statistics of command call
+;; frequency.
;; HOW TO USE
@@ -22,20 +24,31 @@
;; Important command/insert mode switch keys:
-;; xah-fly-command-mode-activate (press <home> or F8 or Alt+Space or
Ctrl+Space or menu key)
+;; xah-fly-command-mode-activate (press <home> or F8 or Alt+Space or
+;; Ctrl+Space or menu key)
-;; xah-fly-insert-mode-activate (when in command mode, press qwerty letter key
f.)
+;; xah-fly-insert-mode-activate (when in command mode, press qwerty
+;; letter key f.)
;; When in command mode:
+
;; "f" calls `xah-fly-insert-mode-activate'.
-;; Space is a leader key. For example, "SPC r" calls `query-replace'. Press
"SPC C-h" to see the full list.
+
+;; Space is a leader key. For example, "SPC r" calls `query-replace'.
+;; Press "SPC C-h" to see the full list.
+
;; "SPC SPC" also activates insertion mode.
-;; "SPC RET" calls `execute-extended-command-for-buffer' (if emacs 28), else
`execute-extended-command'.
+
+;; "SPC RET" calls `execute-extended-command-for-buffer' (if emacs
+;; 28), else `execute-extended-command'.
+
;; "a" calls `execute-extended-command'.
-;; The leader key sequence basically replace ALL emacs commands that starts
with C-x key.
+;; The leader key sequence basically replace ALL emacs commands that
+;; starts with C-x key.
-;; When using xah-fly-keys, you don't need to press Control or Meta, with the
following exceptions:
+;; When using xah-fly-keys, you don't need to press Control or Meta,
+;; with the following exceptions:
;; "C-c" for major mode commands.
;; "C-g" for cancel.
@@ -46,30 +59,36 @@
;; You NEVER need to press "C-x"
-;; Any emacs command that has a keybinding starting with C-x, has also a key
sequence binding in xah-fly-keys. For example,
+;; Any emacs command that has a keybinding starting with C-x, has also
+;; a key sequence binding in xah-fly-keys. For example,
+
;; "C-x b" for `switch-to-buffer' is "SPC f"
;; "C-x C-f" for `find-file' is "SPC i e"
;; "C-x n n" for `narrow-to-region' is "SPC l l"
-;; The first key we call it leader key. In the above examples, the SPC is the
leader key.
+
+;; The first key we call it leader key. In the above examples, the SPC
+;; is the leader key.
;; When in command mode, the "SPC" is a leader key.
;; the following standard keys with Control are supported:
- ;; "C-TAB" `xah-next-user-buffer'
- ;; "C-S-TAB" `xah-previous-user-buffer'
- ;; "C-v" paste
- ;; "C-w" close
- ;; "C-z" undo
- ;; "C-n" new
- ;; "C-o" open
- ;; "C-s" save
- ;; "C-S-s" save as
- ;; "C-S-t" open last closed
- ;; "C-+" `text-scale-increase'
- ;; "C--" `text-scale-decrease'
-
-;; To disable both Control and Meta shortcut keys, add the following lines to
you init.el before (require 'xah-fly-keys):
+;; "C-TAB" `xah-next-user-buffer'
+;; "C-S-TAB" `xah-previous-user-buffer'
+;; "C-v" paste
+;; "C-w" close
+;; "C-z" undo
+;; "C-n" new
+;; "C-o" open
+;; "C-s" save
+;; "C-S-s" save as
+;; "C-S-t" open last closed
+;; "C-+" `text-scale-increase'
+;; "C--" `text-scale-decrease'
+
+;; To disable both Control and Meta shortcut keys, add the following
+;; lines to you init.el before (require 'xah-fly-keys):
+
;; (setq xah-fly-use-control-key nil)
;; (setq xah-fly-use-meta-key nil)
@@ -78,7 +97,9 @@
;; For detail about design and other info, see home page at
;; http://xahlee.info/emacs/misc/ergoemacs_vi_mode.html
-;; If you like this project, Buy Xah Emacs Tutorial
http://xahlee.info/emacs/emacs/buy_xah_emacs_tutorial.html or make a donation.
Thanks.
+;; If you like this project, Buy Xah Emacs Tutorial
+;; http://xahlee.info/emacs/emacs/buy_xah_emacs_tutorial.html or make
+;; a donation. Thanks.
;;; Installation:
;; here's how to manual install
