Add ui/doom/README.org

TODO.org

@@ -5,7 +5,7 @@
 + [-] Work-in-progress
 + [X] Complete
 
-** Unreleased [45/123]
+** Unreleased [46/123]
 + [1/12] Potential plugins
   + [ ] [[https://github.com/emacs-lsp/lsp-mode][lsp-mode]]: client for MS Language Server Protocol, keep an eye on this
   + [ ] lang/javascript: [[https://github.com/codesuki/add-node-modules-path][add-node-modules-path]] (adds node_modules to ~exec-path~)
@@ -25,7 +25,7 @@
   + [ ] app/irc
   + [-] app/crm
   + [-] app/write
-+ [1/57] Add README.org's (with working babel blocks?) to modules (see [[modules/lang/go/README.org][lang/go/README.org]]) to replace bootstaps
++ [2/57] Add README.org's (with working babel blocks?) to modules (see [[modules/lang/go/README.org][lang/go/README.org]]) to replace bootstaps
   + [0/8] :tools
     + [ ] dired
     + [ ] electric-indent
@@ -72,8 +72,8 @@
     + [ ] syntax-checker
     + [ ] version-control
     + [ ] workspaces
-  + [0/5] :ui
-    + [ ] doom
+  + [1/5] :ui
+    + [X] doom
     + [ ] doom-dashboard
     + [ ] doom-modeline
     + [ ] doom-quit

modules/ui/doom/README.org

@@ -0,0 +1,25 @@
+* DOOM
+
+DOOM's look is loosely inspired by Atom's One Dark theme. I've my [[https://github.com/hlissner/emacs-doom-theme/][doom-themes]]
+plugin to thank for bringing it to Emacs.
+
+On top of that, it uses:
+
++ [[https://github.com/mozilla/Fira][Fira Mono]] (font)
++ [[https://github.com/rolandwalker/nav-flash][nav-flash]]: blinks the current line when jumping large distances, to help keep track of the cursor.
++ ~hideshow~, modified to use a nicer folded-region indicator.
++ Custom fringe bitmaps for ~git-gutter-fringe~ (thin bars)
+
+** Installation
+[[https://github.com/mozilla/Fira][Fira Mono]] is this module's only dependency (if you want to use it).
+
+*** MacOS
+#+BEGIN_SRC sh :tangle (if (doom-system-os 'macos) "yes")
+brew tap caskroom/fonts
+brew cask install font-fira-mono
+#+END_SRC
+
+*** Arch Linux
+#+BEGIN_SRC sh :dir /sudo:: :tangle (if (doom-system-os 'arch) "yes")
+sudo pacman --noconfirm --needed -S ttf-fira-mono
+#+END_SRC