Skip to content

Commit e09c0e4

Browse files
committed
docs(MANUAL): add overview for input providers
References dvcrn#228
1 parent bc322c7 commit e09c0e4

File tree

2 files changed

+28
-12
lines changed

2 files changed

+28
-12
lines changed

MANUAL.md

+11
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
- [Syntax specific configuration](#syntax-specific-configuration)
77
- [Custom SPC keybinding](#custom-spc-keybinding)
88
- [Editor keymaps](#editor-keymaps)
9+
- [Editor keybindings](#editor-keybindings)
910

1011
<!-- /MDTOC -->
1112

@@ -88,5 +89,15 @@ As you can see, this is a very similar format that atom uses to describe it's ke
8889

8990
So in the example above, we add a new keymap that is only available in insert mode and is getting triggered by typing `f` followed by `d`. Executing the keymap will result in vim mode jumping back to normal mode.
9091

92+
## Editor keybindings
93+
94+
Since v0.12.0, proton allows you to switch between a handful of keybindings. By default vim-centric keybindings are used for everything but you can easily change that inside your `~/.proton` with the `proton.core.inputProvider` setting as documented [here](https://github.com/dvcrn/proton/tree/master/src/cljs/proton/layers/core#configuration).
95+
96+
Available modes are:
97+
- `vim-mode`: proton keys are on `SPC`, uses Atoms core [vim-mode](https://github.com/atom/vim-mode)
98+
- `vim-mode-plus` __(default)__: proton keys are on `SPC`, uses vim-mode-plus [vim-mode](https://github.com/t9md/atom-vim-mode-plus)
99+
- `default`: no special keybindings. proton keys are on `ALT-m`, mode keys on `CTR-ALT-m`
100+
- `emacs`: mirrors emacs keybindings through [atomic emacs](https://github.com/avendael/atomic-emacs). proton keys are on `ALT-m`, mode keys on `CTR-ALT-m`. (You could compare this to `holy-mode` in spacemacs, maybe.)
101+
91102

92103
_More following soon..._

README.md

+17-12
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,30 @@
66

77
<!-- MDTOC maxdepth:4 firsth1:1 numbering:0 flatten:0 bullets:1 updateOnSave:1 -->
88

9-
- [Proton](#proton)
10-
- [What is it?](#what-is-it)
11-
- [Features](#features)
12-
- [Install](#install)
13-
- [Pre-warning](#pre-warning)
14-
- [Going full Proton](#going-full-proton)
15-
- [Compiling](#compiling)
16-
- [Requirements](#requirements)
17-
- [Running it](#running-it)
18-
- [Help](#help)
19-
- [License](#license)
9+
- [Proton](#proton)
10+
- [What is it?](#what-is-it)
11+
- [Usage](#usage)
12+
- [Features](#features)
13+
- [Install](#install)
14+
- [Pre-warning](#pre-warning)
15+
- [Going full Proton](#going-full-proton)
16+
- [Compiling](#compiling)
17+
- [Requirements](#requirements)
18+
- [Running it](#running-it)
19+
- [Help](#help)
20+
- [License](#license)
2021

2122
<!-- /MDTOC -->
2223

2324
### What is it?
2425

2526
Proton *(name subject to change)* brings the modal editing style of Spacemacs and Sublimious with all its superpowers to Atom.
2627

27-
We get rid of the annoying part of Atom — that being the configuration and package management — and __concentrate on the cool bits__: its full customisation capabilities.
28+
We get rid of the annoying part of Atom — that being the configuration and package management — and __concentrate on the cool bits__: its full customization capabilities.
29+
30+
### Usage
31+
While not ready yet, a manual is slowly getting created [here](https://github.com/dvcrn/proton/blob/master/MANUAL.md)
32+
2833

2934
### Features
3035
##### :handbag: dotfile friendly configuration

0 commit comments

Comments
 (0)