Skip to content
This repository was archived by the owner on Apr 24, 2022. It is now read-only.

Commit e842912

Browse files
committed
Update README
1 parent 434ab5d commit e842912

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Forked from [`vim-win`](https://github.com/dstein64/vim-win):
1212

1313
`libmodal` is a Neo/vim library/plugin aimed at simplifying the creation of new "modes" (e.g. Insert, Normal). The entrance of modes is user-defined, and their exit defaults to `<Esc>`. The function and name of modes is also user-defined, and is outlined in `libmodal-usage`.
1414

15+
If you use Neovim, try [nvim-libmodal][libmodal] instead!
16+
1517
# Installation
1618

1719
Use the built-in package manager or one of the various package managers.
@@ -23,6 +25,10 @@ Use the built-in package manager or one of the various package managers.
2325
| Vim-Plug | `Plug 'https://github.com/Iron-E/vim-libmodal'` |
2426
| Vundle | `Plugin 'https://github.com/Iron-E/vim-libmodal'` |
2527

28+
## Requirements
29+
30+
* [nvim-libmodal][libmodal] is __not__ installed.
31+
2632
# Usage
2733

2834
## Commands
@@ -246,3 +252,5 @@ The following highlight groups can be configured to change a mode's colors:
246252
|:-----------------|:-------------|:------------------------------------|
247253
| `LibmodalPrompt` | `ModeMsg` | Color for the mode text. |
248254
| `LibmodalStar` | `StatusLine` | Color for the `*` at the beginning. |
255+
256+
[libmodal]: https://github.com/Iron-E/nvim-libmodal

0 commit comments

Comments
 (0)