Lots of additions to README

4 files changed, 93 insertions, 24 deletions

diff --git a/.gitignore b/.gitignore
index 4fd8c69..369f22a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,3 +2,4 @@
 /eln-cache/
 /elpa/
 /history
+/transient/
diff --git a/README.md b/README.md
index 1d7fa3f..4b2b531 100644
--- a/README.md
+++ b/README.md
@@ -22,12 +22,73 @@ This is a minimal Emacs starter kit. Like, *really* minimal. Here's the short of
  
    We keep things *crushingly* simple here. That means no fancy loadable modules or whatnot. Everything is as straight-forward as can be.
 
+There are two files of interest: `early-init.el` and `init.el`.
+
+### `early-init.el`
+
+The early init file uses *strictly* built-in Emacs features to do the following:
+
+ - Improve startup time
+ - Add minor UI niceties (e.g. clock in the tab-bar, full-screen by default, etc.)
+ - Set the default theme (`modus-vivendi`)
+ - Turn on discovery aids (e.g. `help-quick`, `fido-vertical-mode`, etc.)
+
+This should be a decent start to improving the out-of-the-box behavior of Emacs.
+
+### `init.el`
+
+For those who'd like a little more help in making Emacs comfortable and discoverable, the `init.el` file provided adds the following packages:
+
+ - [avy](https://github.com/abo-abo/avy)
+ - [which-key](https://github.com/justbur/emacs-which-key)
+ - [magit](https://magit.vc)
+ - [vertico](https://github.com/minad/vertico)
+ - [marginalia](https://github.com/minad/marginalia/)
+ - [corfu](https://github.com/minad/corfu)
+ - [consult](https://github.com/minad/consult)
+ - [orderless](https://github.com/oantolin/orderless)
+
+Along with a few ancillary packages that enhance the above.
+
+## Using
+
+Clone this repository wherever. Then you should copy `early-init.el` and (optionally) `init.el` into your `~/.emacs.d/` repository:
+
+```bash
+git clone https://git.sr.ht/~ashton314/emacs-bedrock
+mkdir -p ~/.emacs.d/
+cp emacs-bedrock/early-init.el ~/.emacs.d/
+cp emacs-bedrock/init.el ~/.emacs.d/                     # optional!
+```
+
+Fire up Emacs and you're good to go!
+
+### Philosophy
+
+Many people are looking for a good set of defaults and some easy-to-use switches that let Emacs get out of the way and let them work on what they want to. This is fine. This is not what Bedrock tries to do.
+
+Emacs is the most customizable piece of software in existence. (No citation needed.) My goal with Bedrock is to make Emacs a little nicer by enabling some things that I personally think should be enabled by default. Bedrock goes a little further by suggesting a few well-built packages that go on to enhance the experience.
+
+Bedrock encourages inspection and modification. I don't plan on making some core that periodically gets updated. You can think of this as just some guy's config that you wanted to adopt.
+
+When I started learning Emacs, my dad gave me his `.emacs` file. (That's what we used back in ye olden days instead of `.emacs.d/init.el` and stuff.) I used it without modification for many years. Eventually I learned how to write my own functions and customizations. This package aims to give other users a similar experience.
+
 ## Requirements
 
 Emacs 29.1 or later.
 
 Yes, as of writing, Emacs 29.1 hasn't been released yet. The reason why is because we are relying on `use-pacakge` to be built-in.
 
+## Development
+
+This is version `0.0.1`.
+
+Once I am happy with the state of things, I'll change it to version `1.*.*`—at that point, no new `use-package` declarations will be added to `init.el`.
+
+This is a hobby project. Please be patient.
+
+For testing, you can run `emacs --init-directory path/to/emacs-bedrock/` and all the customizations and package installations will be isolated to the project directory. Emacs should only add files that are already in the `.gitignore`.
+
 ## Authors
 
  - Ashton Wiersdorf
diff --git a/early-init.el b/early-init.el
index 35e1be5..d551d82 100644
--- a/early-init.el
+++ b/early-init.el
@@ -1,8 +1,7 @@
 ;;; Basic settings for speed and convenience
 (setq gc-cons-threshold 100000000)
 (setq byte-compile-warnings '(not obsolete))
-(setq warning-suppress-log-types '((comp)))
-(setq bidi-inhibit-bpa t)                                        ; turn this off if you need right-to-left text
+(setq warning-suppress-log-types '((comp) (bytecomp)))
 (setq x-underline-at-descent-line nil)
 (setq line-number-mode t)
 (setq column-number-mode t)
@@ -16,15 +15,17 @@
 
 (setq-default show-trailing-whitespace nil)
 (setq-default indicate-buffer-boundaries 'left)
-(setq-default indent-tabs-mode nil)
-(setq-default tab-width 4)
-(setq-default fill-column 80)
 
-;; horizontal scrolling
+;; We won't set these, but they're good to know about
+;;
+;; (setq-default indent-tabs-mode nil)
+;; (setq-default tab-width 4)
+
+;; Enable horizontal scrolling
 (setq mouse-wheel-tilt-scroll t)
 (setq mouse-wheel-flip-direction t)
 
-;; minibuffer/completion
+;; Minibuffer/completion
 ;; https://www.masteringemacs.org/article/understanding-minibuffer-completion
 (setq enable-recursive-minibuffers t)
 (setq completion-cycle-threshold 1)
@@ -66,7 +67,10 @@
 
 ;;; Completion
 (fido-vertical-mode)
-(setq completion-styles '(initials flex))
+(setq completion-styles '(basic initials substring))
 
 ;;; Line numbers
 (add-hook 'prog-mode-hook 'display-line-numbers-mode)
+
+;;; Help buffer
+(add-hook 'after-init-hook 'help-quick)
diff --git a/init.el b/init.el
index 8ed3011..b043aca 100644
--- a/init.el
+++ b/init.el
@@ -12,6 +12,12 @@
   :config
   (which-key-mode))
 
+;;; Utilities
+
+;; Magit: best Git client to ever exist
+(use-package magit
+  :ensure t)
+
 ;;; Minibuffer and completion
 
 ;; Vertico: better vertical completion for minibuffer commands
@@ -35,17 +41,17 @@
 
 ;; Part of corfu
 (use-package corfu-popupinfo
-    :after corfu
-    :hook (corfu-mode . corfu-popupinfo-mode)
-    :bind (:map corfu-map
-                ("M-h" . corfu-popupinfo-toggle)
-                ("M-k" . corfu-popupinfo-scroll-down)
-                ("M-j" . corfu-popupinfo-scroll-up))
-    :custom
-    (corfu-popupinfo-delay '(0.25 . 0.1))
-    (corfu-popupinfo-hide nil)
-    :config
-    (corfu-popupinfo-mode))
+  :after corfu
+  :hook (corfu-mode . corfu-popupinfo-mode)
+  :bind (:map corfu-map
+              ("M-h" . corfu-popupinfo-toggle)
+              ("M-k" . corfu-popupinfo-scroll-down)
+              ("M-j" . corfu-popupinfo-scroll-up))
+  :custom
+  (corfu-popupinfo-delay '(0.25 . 0.1))
+  (corfu-popupinfo-hide nil)
+  :config
+  (corfu-popupinfo-mode))
 
 ;; Make corfu popup come up in terminal overlay
 (use-package corfu-terminal
@@ -56,6 +62,7 @@
 
 ;; Pretty icons for corfu
 (use-package kind-icon
+  :if (display-graphic-p)
   :ensure t
   :after corfu
   :config
@@ -64,8 +71,7 @@
 ;; Consult: Misc. enhanced commands
 (use-package consult
   :ensure t
-  :bind (
-         ("C-x b" . consult-buffer) ;; orig. switch-to-buffer
+  :bind (("C-x b" . consult-buffer) ;; orig. switch-to-buffer
          ("M-y" . consult-yank-pop) ;; orig. yank-pop
          ("C-s" . consult-line)     ;; orig. isearch
          ))
@@ -89,6 +95,3 @@
  ;; Your init file should contain only one such instance.
  ;; If there is more than one, they won't work right.
  )
-
-;; Fire up the help buffer
-(help-quick)