[bepo] Update the README

This commit is contained in:
Fabien Dubosson 2016-01-09 21:43:06 +01:00
parent 278e67db5e
commit 5685af2abb

View file

@ -49,14 +49,17 @@ enabled list or not.
#+end_src
** Customization
It is possible to override the bindings or add new ones by defining in your own
layer, or in the =user-init=, some functions named =bepo/pre-config-<NAME>= and
It is possible to override or add bindings by defining in your own layer (or in
the =user-init=) some functions named =bepo/pre-config-<NAME>= and
=bepo/post-config-<NAME>=. They are respectively called just before and after
the actual configuration of keybindings. =<NAME>= is the name of the
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
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
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.
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
shortcuts:
on the =en-us= keyboard layout. They are used as aliases for other shortcuts:
- Map unused ~é~ key as an alias of ~w~, more useful in vim mode:
- ~é → w~
@ -108,8 +110,8 @@ because there are better alternatives, or because some moves don't make sense.
#+begin_verse
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".
As it is not useful to move left on =magit=, because operations are done on
lines, the ~c~ is not remapped.
As it is not useful to move left on =magit= because operations are done line by
line the ~c~ is not remapped.
#+end_verse
Note: One difference exists with the wiki version: the ~w~ is *not* remapped to
@ -122,7 +124,9 @@ The available configurations are:
- ace-window
- avy
- buffer-move
- comint-mode
- company
- elfeed
- evil
- evil-escape
- evil-surround
@ -134,6 +138,7 @@ The available configurations are:
- helm-buffers
- helm-files
- helm-locate
- ivy
- magit
- neotree
- org