Standardize the READMEs of various modules

modules/app/calendar/README.org

@@ -0,0 +1,66 @@
+#+TITLE:   app/calendar
+#+DATE:    January 13, 2018
+#+SINCE:   v2.1
+#+STARTUP: inlineimages
+
+* Table of Contents :TOC:
+- [[#description][Description]]
+  - [[#module-flags][Module Flags]]
+  - [[#packages][Packages]]
+- [[#configuration][Configuration]]
+  - [[#changing-calendar-sources][Changing calendar sources]]
+  - [[#synchronizing-org-and-google-calendar][Synchronizing Org and Google Calendar]]
+
+* Description
+This module adds a calendar view for Emacs, with org and google calendar sync
+support.
+
+** Module Flags
+This module provides no flags.
+
+** Packages
++ [[https://github.com/kiwanami/emacs-calfw][calfw]]
++ [[https://github.com/kiwanami/emacs-calfw][calfw-org]]
++ [[https://github.com/myuhe/org-gcal.el][org-gcal]]
+
+* Configuration
+** Changing calendar sources
+By defining your own calendar commands, you can control what sources to pull
+calendar data from:
+
+#+BEGIN_SRC emacs-lisp
+(defun my-open-calendar ()
+  (interactive)
+  (cfw:open-calendar-buffer
+   :contents-sources
+   (list
+    (cfw:org-create-source "Green")  ; orgmode source
+    (cfw:howm-create-source "Blue")  ; howm source
+    (cfw:cal-create-source "Orange") ; diary source
+    (cfw:ical-create-source "Moon" "~/moon.ics" "Gray")  ; ICS source1
+    (cfw:ical-create-source "gcal" "https://..../basic.ics" "IndianRed") ; google calendar ICS
+   )))
+#+END_SRC
+
+To control what org files ~clfw:org-create-source~ will use, ~let~-bind
+~org-agenda-files~ around a call to ~+calendar/open-calendar~ like so:
+
+#+BEGIN_SRC emacs-lisp
+;;;###autoload
+(defun cfw:open-org-calendar-with-cal1 ()
+  (interactive)
+  (let ((org-agenda-files '("/path/to/org/" "/path/to/cal1.org")))
+    (call-interactively #'+calendar/open-calendar)))
+
+;;;###autoload
+(defun cfw:open-org-calendar-with-cal2 ()
+  (interactive)
+  (let ((org-agenda-files '("/path/to/org/" "/path/to/cal2.org")))
+    (call-interactively #'+calendar/open-calendar)))
+#+END_SRC
+
+The [[https://github.com/kiwanami/emacs-calfw][kiwanami/emacs-calfw]] project readme contains more examples.
+
+** Synchronizing Org and Google Calendar
+The [[https://github.com/myuhe/org-gcal.el][myuhe/org-gcal.el]] project README contains more detailed instructions on how
+to link your calendar with Google calendars.

modules/app/calendar/readme.org

@@ -1,71 +0,0 @@
-#+TITLE: `=Calendar App`
-* Setup sync between google calendar and org file
-:PROPERTIES:
-:ID:       5E190E8A-CA26-4679-B5F8-BF9CFD289271
-:END:
-- Checkout https://github.com/myuhe/org-gcal.el, put the following content in a file ~secret.el~ and set the variable `+calendar-org-gcal-secret-file` to the path of that file.
-  #+BEGIN_SRC emacs-lisp
-(setq org-gcal-client-id "your-id-foo.apps.googleusercontent.com"
-      org-gcal-client-secret "your-secret"
-      org-gcal-file-alist '(("your-mail@gmail.com" .  "~/schedule.org")
-                            ("another-mail@gmail.com" .  "~/task.org")))
-  #+END_SRC
-* Doom faces
-:PROPERTIES:
-:ID:       8223894E-EA68-4259-A2EA-AF7E3653C610
-:END:
-I'm using the following setting:
-#+BEGIN_SRC emacs-lisp
-;; calfw
-(cfw:face-title              :foreground blue                     :bold bold :height 2.0 :inherit 'variable-pitch)
-(cfw:face-header             :foreground (doom-blend blue bg 0.8) :bold bold)
-(cfw:face-sunday             :foreground (doom-blend red bg 0.8)  :bold bold)
-(cfw:face-saturday           :foreground (doom-blend red bg 0.8)  :bold bold)
-(cfw:face-holiday            :foreground nil :background bg-alt   :bold bold)
-(cfw:face-grid               :foreground vertical-bar)
-(cfw:face-periods            :foreground yellow)
-(cfw:face-toolbar            :foreground nil :background nil)
-(cfw:face-toolbar-button-off :foreground base6                    :bold bold             :inherit 'variable-pitch)
-(cfw:face-toolbar-button-on  :foreground blue                     :bold bold             :inherit 'variable-pitch)
-
-(cfw:face-default-content    :foreground fg)
-(cfw:face-day-title          :foreground fg                       :bold bold)
-(cfw:face-today-title        :foreground bg  :background blue     :bold bold)
-(cfw:face-default-day                                             :bold bold)
-(cfw:face-today              :foreground nil :background nil      :bold bold)
-(cfw:face-annotation         :foreground violet)
-(cfw:face-disable            :foreground grey)
-(cfw:face-select                             :background region)
-#+END_SRC
-* Adjust calendar to be included
-:PROPERTIES:
-:ID:       D734975C-4B49-4F66-A088-AB2707A77537
-:END:
-Checkout example from https://github.com/kiwanami/emacs-calfw
-#+BEGIN_SRC emacs-lisp
-(defun my-open-calendar ()
-  (interactive)
-  (cfw:open-calendar-buffer
-   :contents-sources
-   (list
-    (cfw:org-create-source "Green")  ; orgmode source
-    (cfw:howm-create-source "Blue")  ; howm source
-    (cfw:cal-create-source "Orange") ; diary source
-    (cfw:ical-create-source "Moon" "~/moon.ics" "Gray")  ; ICS source1
-    (cfw:ical-create-source "gcal" "https://..../basic.ics" "IndianRed") ; google calendar ICS
-   ))) 
-#+END_SRC
-Specifically, if you want to adjust the org files to be included, use a ~let~ binding to set the ~org-agenda-files~ like below:
-#+BEGIN_SRC emacs-lisp
-;;;###autoload
-(defun cfw:open-org-calendar-with-cal1 ()
-  (interactive)
-  (let ((org-agenda-files '("/path/to/org/" "/path/to/cal1.org")))
-    (call-interactively '+calendar/open-calendar)))
-
-;;;###autoload
-(defun cfw:open-org-calendar-with-cal2 ()
-  (interactive)
-  (let ((org-agenda-files '("/path/to/org/" "/path/to/cal2.org")))
-    (call-interactively '+calendar/open-calendar)))
-#+END_SRC

modules/editor/parinfer/README.org

@@ -1,3 +1,23 @@
-#+TITLE: :editor parinfer
+#+TITLE:   editor/parinfer
+#+DATE:    June 9, 2018
+#+SINCE:   v2.1
+#+STARTUP: inlineimages
 
-You can find out more about parinfer at https://shaunlebron.github.io/parinfer/
+* Table of Contents :TOC:
+- [[#description][Description]]
+  - [[#module-flags][Module Flags]]
+  - [[#packages][Packages]]
+
+* Description
+Parinfer is a proof-of-concept editor mode for Lisp programming languages. It
+will infer some changes to keep Parens and Indentation inline with one another.
+
+https://raw.githubusercontent.com/DogLooksGood/parinfer-mode/a7c041454e05ec2b88333a73e72debaa671ed596/images/demo.gif
+
+More information can be found about it [[https://shaunlebron.github.io/parinfer/][in the project's documentation]].
+
+** Module Flags
+This module provides no flags.
+
+** Packages
++ [[https://github.com/DogLooksGood/parinfer-mode][parinfer]]

modules/lang/javascript/README.org

@@ -1,5 +1,19 @@
-#+TITLE: :lang javascript
+#+TITLE:   lang/javascript
+#+DATE:    January 16, 2017
+#+SINCE:   v2.0
+#+STARTUP: inlineimages
 
+* Table of Contents :TOC:
+- [[#description][Description]]
+  - [[#module-flags][Module Flags]]
+  - [[#packages][Packages]]
+- [[#prerequisites][Prerequisites]]
+  - [[#macos][MacOS]]
+  - [[#arch-linux][Arch Linux]]
+- [[#appendix][Appendix]]
+  - [[#commands][Commands]]
+
+* Description
 This module adds Javascript support.
 
 + Code completion (tide)
@@ -10,22 +24,34 @@ This module adds Javascript support.
 + Coffeescript & JSX support
 + Jump-to-definitions and references support (xref)
 
-* Table of Contents :TOC:
+** Module Flags
-- [[#install][Install]]
++ =+lsp= Enables LangServer support for this module. You must have =:tools lsp=
-  - [[#node--npm][Node & NPM]]
+  enabled for this to work, as well as the langserver (e.g.
-- [[#appendix][Appendix]]
+  typescript-language-server) installed on your system.
-  - [[#commands][Commands]]
 
-* Install
+** Packages
-** Node & NPM
++ [[https://github.com/defunkt/coffee-mode][coffee-mode]]
-To get started with Javascript, you'll need node and its package manager, NPM, installed.
++ [[https://github.com/mooz/js2-mode][js2-mode]]
++ [[https://github.com/felipeochoa/rjsx-mode][rjsx-mode]]
++ [[https://github.com/emacs-typescript/typescript.el][typescript-mode]]
++ [[https://github.com/aaronjensen/eslintd-fix][eslintd-fix]]
++ [[https://github.com/magnars/js2-refactor.el][js2-refactor]]
++ [[https://github.com/mojochao/npm-mode][npm-mode]]
++ [[https://github.com/abicky/nodejs-repl.el][nodejs-repl]]
++ [[https://github.com/skeeto/skewer-mode][skewer-mode]]
++ [[https://github.com/ananthakumaran/tide][tide]]
++ [[https://github.com/NicolasPetton/xref-js2][xref-js2]]*
 
-*** MacOS
+* Prerequisites
+Many of this modules' plugins require ~node~ and either ~npm~ or ~yarn~
+installed.
+
+** MacOS
 #+BEGIN_SRC sh :tangle (if (doom-system-os 'macos) "yes")
 brew install node
 #+END_SRC
 
-*** Arch Linux
+** Arch Linux
 #+BEGIN_SRC sh :dir /sudo:: :tangle (if (doom-system-os 'arch) "yes")
 sudo pacman --needed --noconfirm -S nodejs npm
 #+END_SRC

modules/ui/doom-quit/README.org

@@ -1,7 +1,8 @@
-#+TITLE: :ui doom-quit
+#+TITLE:   ui/doom-quit
+#+DATE:    February 19, 2017
+#+SINCE:   v2.0
+#+STARTUP: inlineimages
 
-Remember these?
+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
-[[http://cf.geekdo-images.com/images/pic969210_md.jpg]]
+references that no decent human being has any business recognizing.
-
-Yeah.

modules/ui/doom-quit/config.el

@@ -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!"

modules/ui/window-select/README.org

@@ -1,27 +1,37 @@
-#+TITLE: :ui window-select
+#+TITLE:   ui/window-select
-
+#+DATE:    October 8, 2017
-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.
+#+SINCE:   v2.0.7
+#+STARTUP: inlineimages
 
 * Table of Contents :TOC:
-- [[#install][Install]]
+- [[#description][Description]]
-  - [[#module-flags][Module flags]]
+  - [[#module-flags][Module Flags]]
-- [[#usage][Usage]]
+  - [[#packages][Packages]]
+- [[#prerequisites][Prerequisites]]
+- [[#features][Features]]
 - [[#configuration][Configuration]]
   - [[#ace-window][ace-window]]
   - [[#switch-window][switch-window]]
 
-* Install
+* Description
-Add =:tools lookup= to your init.el.
+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
+** Module Flags
-This module provides two 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.
+If neither flag is specified, ~+ace-window~ is implied.
-+ ~+switch-window~ Use switch-window as the backend.
 
-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

modules/ui/workspaces/README.org

@@ -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:
+** Module Flags
-- [[#install][Install]]
+This module provides no flags.
-- [[#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]]
 
-* 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
+[[../../config/default/+evil-bindings.el][private/default/+bindings.el]]), and corresponding ex commands (if any -- defined
-in [[../../private/default/+evil-commands.el][private/default/+evil-commands.el]]).
+in [[../../editor/evil/+commands.el][private/default/+evil-commands.el]]).
 
 | command                   | key / ex command           | description                                                |
 |---------------------------+----------------------------+------------------------------------------------------------|