TakeV/spacemacs
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

[bepo] Update the README

Browse source
This commit is contained in:
Fabien Dubosson 2016-01-09 21:43:06 +01:00
parent 278e67db5e
commit 5685af2abb
1 changed files with 12 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
layers/+keyboard-layouts/bepo/README.org
View file

@ -49,14 +49,17 @@ enabled list or not.
#+end_src #+end_src
** Customization ** Customization
It is possible to override the bindings or add new ones by defining in your own It is possible to override or add bindings by defining in your own layer (or in
layer, or in the =user-init=, some functions named =bepo/pre-config-<NAME>= and the =user-init=) some functions named =bepo/pre-config-<NAME>= and
=bepo/post-config-<NAME>=. They are respectively called just before and after =bepo/post-config-<NAME>=. They are respectively called just before and after
the actual configuration of keybindings. =<NAME>= is the name of the the actual configuration of keybindings. =<NAME>= is the name of the
configuration you want to customize, they are listed under [[Configurations]]. configuration you want to customize, they are listed under [[Configurations]].
Note: If you define some of these functions in your own layer, be sure that the
=bepo= layer is placed after it in the =dotspacemacs-configuration-layers= list.
* Mapping * Mapping
The mapping correction is the one proposed for vim on the bepo's official [[http://bepo.fr/wiki/Vim#Principe][wiki]]. The mapping correction is the one proposed for vim on the official bepo [[http://bepo.fr/wiki/Vim#Principe][wiki]].
This layer tries to do the following changes when the following letters are used This layer tries to do the following changes when the following letters are used
for *doing a movement*: for *doing a movement*:
@ -77,8 +80,7 @@ they are used to represent a movement, or to keep the mnemonic between the
lower/upper-case consistent. lower/upper-case consistent.
Some bepo keys are not used in traditional mapping, mainly because they are not Some bepo keys are not used in traditional mapping, mainly because they are not
present on the =en-us= keyboard layout. They can be used as an alias for other on the =en-us= keyboard layout. They are used as aliases for other shortcuts:
shortcuts:
- Map unused ~é~ key as an alias of ~w~, more useful in vim mode: - Map unused ~é~ key as an alias of ~w~, more useful in vim mode:
- ~é → w~ - ~é → w~
@ -108,8 +110,8 @@ because there are better alternatives, or because some moves don't make sense.
#+begin_verse #+begin_verse
Example: In the =magit= status buffer, the ~c~ is used for =commit= by default, Example: In the =magit= status buffer, the ~c~ is used for =commit= by default,
but if we want to follow the conventions, it should be remapped to "move left". but if we want to follow the conventions, it should be remapped to "move left".
As it is not useful to move left on =magit=, because operations are done on As it is not useful to move left on =magit= because operations are done line by
lines, the ~c~ is not remapped. line the ~c~ is not remapped.
#+end_verse #+end_verse
Note: One difference exists with the wiki version: the ~w~ is *not* remapped to Note: One difference exists with the wiki version: the ~w~ is *not* remapped to
@ -122,7 +124,9 @@ The available configurations are:
- ace-window - ace-window
- avy - avy
- buffer-move - buffer-move
- comint-mode
- company - company
- elfeed
- evil - evil
- evil-escape - evil-escape
- evil-surround - evil-surround
@ -134,6 +138,7 @@ The available configurations are:
- helm-buffers - helm-buffers
- helm-files - helm-files
- helm-locate - helm-locate
- ivy
- magit - magit
- neotree - neotree
- org - org