Standardize the READMEs of various modules

This commit is contained in:
Henrik Lissner 2019-05-09 21:31:23 -04:00
parent d7bc99c3c3
commit ca8202c224
No known key found for this signature in database
GPG key ID: 5F6C0EA160557395
8 changed files with 184 additions and 123 deletions

View file

@ -1,5 +1,23 @@
#+TITLE: :ui workspaces
#+TITLE: ui/workspaces
#+DATE: February 4, 2017
#+SINCE: v2.1
#+STARTUP: inlineimages
* Table of Contents :TOC:
- [[#description][Description]]
- [[#module-flags][Module Flags]]
- [[#packages][Packages]]
- [[#prerequisites][Prerequisites]]
- [[#features][Features]]
- [[#isolated-buffer-list][Isolated buffer-list]]
- [[#automatic-workspaces][Automatic workspaces]]
- [[#session-persistence][Session persistence]]
- [[#workspace-persistence][Workspace persistence]]
- [[#appendix][Appendix]]
- [[#commands--keybindings][Commands & Keybindings]]
- [[#api][API]]
* Description
This module adds support for workspaces, powered by persp_mode, as well as a API
for manipulating them.
@ -12,18 +30,13 @@ need to check my email, so mu4e gets its own workspace.
Once I've completed the task, I close the workspace and return to main.
#+end_quote
* Table of Contents :TOC:
- [[#install][Install]]
- [[#features][Features]]
- [[#isolated-buffer-list][Isolated buffer-list]]
- [[#automatic-workspaces][Automatic workspaces]]
- [[#session-persistence][Session persistence]]
- [[#workspace-persistence][Workspace persistence]]
- [[#appendix][Appendix]]
- [[#commands--keybindings][Commands & Keybindings]]
- [[#api][API]]
** Module Flags
This module provides no flags.
* Install
** Packages
+ [[https://github.com/Bad-ptr/persp-mode.el][persp-mode]]
* Prerequisites
This module has no additional dependencies.
* Features
@ -53,8 +66,8 @@ be loaded into the current session (as another workspace) with ~M-x
* Appendix
** Commands & Keybindings
Here is a list of available commands, their default keybindings (defined in
[[../../private/default/+bindings.el][private/default/+bindings.el]]), and corresponding ex commands (if any -- defined
in [[../../private/default/+evil-commands.el][private/default/+evil-commands.el]]).
[[../../config/default/+evil-bindings.el][private/default/+bindings.el]]), and corresponding ex commands (if any -- defined
in [[../../editor/evil/+commands.el][private/default/+evil-commands.el]]).
| command | key / ex command | description |
|---------------------------+----------------------------+------------------------------------------------------------|