diff options
| author | Ashton Wiersdorf <ashton.wiersdorf@pobox.com> | 2023-01-03 22:21:11 -0700 |
|---|---|---|
| committer | Ashton Wiersdorf <ashton.wiersdorf@pobox.com> | 2023-01-03 22:21:11 -0700 |
| commit | dbf84d04b1bfd32553414b149c7541fef3cec0fa (patch) | |
| tree | 72b17b9313c8448d18b0e4ade83e67ce40697516 /README.md | |
| parent | 301d8d48702bd3cbbae23d6a74de407671bed0c9 (diff) | |
Document mixins
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 23 insertions, 6 deletions
@@ -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: |