emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Standardize the READMEs of various modules

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

13
modules/ui/doom-quit/README.org
View file

@ -1,7 +1,8 @@
#+TITLE: :ui doom-quit
#+TITLE: ui/doom-quit
#+DATE: February 19, 2017
#+SINCE: v2.0
#+STARTUP: inlineimages
Remember these?
[[http://cf.geekdo-images.com/images/pic969210_md.jpg]]
Yeah.
A silly module that prompts you with messages when you try to quit, like DOOM
did. Some quotes are from Doom's quit-message list. Others are random, nerdy
references that no decent human being has any business recognizing.

4
modules/ui/doom-quit/config.el
View file

@ -1,9 +1,5 @@
;;; ui/doom-quit/config.el -*- lexical-binding: t; -*-
;; A silly module that prompts you with messages when you try to quit, like DOOM
;; did. Some quotes are taken from Doom's quit-message list, others are random,
;; nerdy references that no decent human being has any business recognizing.
(defvar +doom-quit-messages
'(;; from Doom 1
"Please don't leave, there's more demons to toast!"

40
modules/ui/window-select/README.org
View file

@ -1,27 +1,37 @@
#+TITLE: :ui window-select
This module provides the user with a visual way to switch windows. By default, the module only kicks in if there are more than two windows open at the same time.
#+TITLE: ui/window-select
#+DATE: October 8, 2017
#+SINCE: v2.0.7
#+STARTUP: inlineimages
* Table of Contents :TOC:
- [[#install][Install]]
- [[#module-flags][Module flags]]
- [[#usage][Usage]]
- [[#description][Description]]
- [[#module-flags][Module Flags]]
- [[#packages][Packages]]
- [[#prerequisites][Prerequisites]]
- [[#features][Features]]
- [[#configuration][Configuration]]
- [[#ace-window][ace-window]]
- [[#switch-window][switch-window]]
* Install
Add =:tools lookup= to your init.el.
* Description
This module provides the user with a visual way to switch windows. By default,
the module only kicks in if there are more than two windows open at the same
time.
** Module flags
This module provides two flags:
** Module Flags
+ =+switch-window= Use the switch-window package as the backend.
+ =+ace-window= Use avy (i.e. ace-window) as the backend.
+ ~+ace-window~ Use avy (and ace-window) as the backend.
+ ~+switch-window~ Use switch-window as the backend.
If neither flag is specified, ~+ace-window~ is implied.
If neither flag is specified, ~+ace-window~ will be used.
** Packages
+ switch-window (if =+switch-window=)
+ ace-window (if =+ace-window= or no flags)
* Usage
* Prerequisites
This module has no additional dependencies.
* Features
This module remaps the function ~other-window~ to either ~switch-window~ or
~ace-window~, depending on which backend you've enabled.
@ -35,7 +45,7 @@ with different visual cues. They are =ace-window= and =switch-window=.
The first character of the buffers changes to a highlighted, user-selectable
character.
+ Pros: The content of the buffers are always visible.
+ Pros: the content of the buffers are always visible.
+ Cons: The displayed characters are small and difficult to see.
** switch-window

41
modules/ui/workspaces/README.org
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 |
|---------------------------+----------------------------+------------------------------------------------------------|