Add ui/doom/README.org

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