aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAshton Wiersdorf <ashton.wiersdorf@pobox.com>2023-01-03 22:21:11 -0700
committerAshton Wiersdorf <ashton.wiersdorf@pobox.com>2023-01-03 22:21:11 -0700
commitdbf84d04b1bfd32553414b149c7541fef3cec0fa (patch)
tree72b17b9313c8448d18b0e4ade83e67ce40697516
parent301d8d48702bd3cbbae23d6a74de407671bed0c9 (diff)
Document mixins
-rw-r--r--README.md29
-rw-r--r--early-init.el8
-rw-r--r--init.el12
-rw-r--r--mixins/dev.el12
4 files changed, 45 insertions, 16 deletions
diff --git a/README.md b/README.md
index b129bb1..9d447de 100644
--- a/README.md
+++ b/README.md
@@ -42,19 +42,30 @@ There are two files of interest: `early-init.el` and `init.el`.
The early init file uses *strictly* built-in Emacs features to do the following:
- Improve startup time
+ - Set up initial frame behavior
+
+### `init.el`
+
+This is where the meat of all configuration goes. This file:
+
- 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.)
+ - Turn on discovery aids (e.g. `help-quick`, `fido-vertical-mode`, [which-key](https://github.com/justbur/emacs-which-key), etc.)
-This should be a decent start to improving the out-of-the-box behavior of Emacs.
+### Mixins
-### `init.el`
+For those who'd like a little more help in tailoring Emacs for specific purposes, the `mixins/` folder contains a few files that can be included via `(load-file "mixin/mixin-name.el")` from the `init.el` file, or copied wholesale or in part into `init.el` directly.
+
+Mixins:
+
+ - UI Enhancements
+ - Development tools
-For those who'd like a little more help in making Emacs comfortable and discoverable, the `init.el` file provided adds the following packages:
+#### `mixins/ui.el`
+
+Packages this mixin uses:
- [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)
@@ -63,6 +74,12 @@ For those who'd like a little more help in making Emacs comfortable and discover
Along with a few ancillary packages that enhance the above.
+#### `mixins/dev.el`
+
+Packages this mixin uses:
+
+ - [magit](https://magit.vc)
+
## Using
Clone this repository wherever. Then you should copy `early-init.el` and (optionally) `init.el` into your `~/.emacs.d/` repository:
diff --git a/early-init.el b/early-init.el
index 080e37d..2c4ca00 100644
--- a/early-init.el
+++ b/early-init.el
@@ -9,14 +9,6 @@
;;; $$$$$$$$/$$/ $$/ $$/ $$$$$$$/ $$$$$$$/$$$$$$$/ $$$$$$$/ $$$$$$$/ $$$$$$$/$$/ $$$$$$/ $$$$$$$/$$/ $$/
-;;; Contents:
-;;;
-;;; - Basic settings for quick startup and convenience
-;;; - Minibuffer/completion settings
-;;; - Interface enhancements/defaults
-;;; - Tab-bar configuration
-;;; - Theme
-
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;
;;; Basic settings for quick startup and convenience
diff --git a/init.el b/init.el
index d04f20d..ad026dc 100644
--- a/init.el
+++ b/init.el
@@ -1,5 +1,13 @@
-;;; Emacs Bedrock
-;;;
+;;; ________ _______ __ __
+;;; / | / \ / | / |
+;;; $$$$$$$$/ _____ ____ ______ _______ _______ $$$$$$$ | ______ ____$$ | ______ ______ _______$$ | __
+;;; $$ |__ / \/ \ / \ / |/ | $$ |__$$ |/ \ / $$ |/ \ / \ / $$ | / |
+;;; $$ | $$$$$$ $$$$ |$$$$$$ /$$$$$$$//$$$$$$$/ $$ $$</$$$$$$ /$$$$$$$ /$$$$$$ /$$$$$$ /$$$$$$$/$$ |_/$$/
+;;; $$$$$/ $$ | $$ | $$ |/ $$ $$ | $$ \ $$$$$$$ $$ $$ $$ | $$ $$ | $$/$$ | $$ $$ | $$ $$<
+;;; $$ |_____$$ | $$ | $$ /$$$$$$$ $$ \_____ $$$$$$ | $$ |__$$ $$$$$$$$/$$ \__$$ $$ | $$ \__$$ $$ \_____$$$$$$ \
+;;; $$ $$ | $$ | $$ $$ $$ $$ / $$/ $$ $$/$$ $$ $$ $$ | $$ $$/$$ $$ | $$ |
+;;; $$$$$$$$/$$/ $$/ $$/ $$$$$$$/ $$$$$$$/$$$$$$$/ $$$$$$$/ $$$$$$$/ $$$$$$$/$$/ $$$$$$/ $$$$$$$/$$/ $$/
+
;;; Minimal init.el
;;; Contents:
diff --git a/mixins/dev.el b/mixins/dev.el
index 4623b95..91c5aa9 100644
--- a/mixins/dev.el
+++ b/mixins/dev.el
@@ -25,3 +25,15 @@
;;; Common file types
;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
+(use-package markdown-mode
+ :ensure t)
+
+(use-package yaml-mode
+ :ensure t)
+
+(use-package json-mode
+ :ensure t)
+
+;; You're almost certain to find a mode for the language you're looking for.
+;; Search the internet to find the right one.