Standardize module READMEs

This commit is contained in:
Henrik Lissner 2017-08-21 20:07:07 +02:00
parent b7d0f4dc3f
commit cbabf6849c
No known key found for this signature in database
GPG key ID: 5F6C0EA160557395
16 changed files with 281 additions and 186 deletions

View file

@ -1,12 +1,16 @@
* :ui evil-goggles
#+TITLE: :ui evil-goggles
This module uses ~evil goggles~ to displays visual hints when editing with evil.
** Install
* Table of Contents :TOC:
- [[#install][Install]]
- [[#configure][Configure]]
* Install
This module requires:
+ ~evil~ (inherently tied to evil mode)
** Configure
* Configure
By default, ~evil-goggles~ will be enabled by default and requires no additional configuration.