Update READMEs & add new ones

modules/ui/doom-modeline/README.org

@@ -0,0 +1,40 @@
+* :ui doom-modeline
+
+This module customizes the Emacs mode-line.
+
+The DOOM modeline was designed for minimalism, and offers:
+
++ A match count panel (for ~evil-search~, ~iedit~ and ~evil-substitute~)
++ An indicator for recording a macro
++ Local python/ruby version in the major-mode
++ A customizable mode-line height (see ~+doom-modeline-height~)
++ An error/warning count segment for flycheck
+
+[[/../screenshots/ml.png]]
+[[/../screenshots/ml-search.png]]
+[[/../screenshots/ml-subst.png]]
+[[/../screenshots/ml-macro.png]]
+[[/../screenshots/ml-version.png]]
+[[/../screenshots/ml-errors.png]]
+
+** Install
+This module requires the fonts included with ~all-the-icons~ to be installed.
+
+Run ~M-x all-the-icons-install-fonts~ to do so.
+
+** Extracting my modeline
+Some might want my modeline without the DOOM config altogether. I've taken some care to make this as easier for you.
+
+Here is what you must do:
+
++ Ensure [[https://github.com/bbatsov/projectile][projectile]] and [[https://github.com/domtronn/all-the-icons.el][all-the-icons]] are installed
++ Ensure ~projectile-mode~ is enabled
++ Ensure the fonts included with ~all-the-icons~ are installed (~M-x all-the-icons-install-fonts~)
++ Replace ~def-package!~ calls with ~use-package~
++ Replace ~doom-project-root~ calls with ~projectile-project-root~
+
+And you /should/ be good to go. As I have never used this out of my config I can't guarantee immediate success, but I'd be happy to help you out. File an issue.
+
+** Troubleshooting
+*** Where are my minor-modes?
+I didn't need it, so I removed it. I wrote ~doom/what-minor-mode~ in the rare case I needed to investigate the currently active minor modes however.

modules/ui/doom/README.org

@@ -1,26 +1,33 @@
-* DOOM
+* :ui 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.
+This module modifies Emacs' user interface.
 
-On top of that, it uses:
+DOOM's look is loosely inspired by Atom's One Dark theme, and is largely contained in the [[https://github.com/hlissner/emacs-doom-theme/][doom-themes]] plugin.
 
-+ [[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.
+By default, this module uses:
+
++ [[https://github.com/mozilla/Fira][Fira Mono and Fira Sans]] (fonts)
++ [[https://dejavu-fonts.github.io/][DejaVu Sans Mono]] (font, for displaying unicode characters)
++ [[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
+** Install
 [[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
+brew cask install font-fira-{sans,mono} font-dejavu-sans
 #+END_SRC
 
 *** Arch Linux
 #+BEGIN_SRC sh :dir /sudo:: :tangle (if (doom-system-os 'arch) "yes")
-sudo pacman --noconfirm --needed -S ttf-fira-mono
+sudo pacman --noconfirm --needed -S ttf-fira-{sans,mono} ttf-dejavu
 #+END_SRC
+
+** Troubleshooting
+*** Strange font symbols
+If you're getting strange unicode symbols, that is likely ~all-the-icons~ doing (caused by other UI modules, specifically [[../doom-modeline][doom-modeline]] and [[../doom-dashboard][doom-dashboard]]).
+
+You must install the fonts included with ~all-the-icons~ with: ~M-x all-the-icons-install-fonts~.