diff options
author | Ashton Wiersdorf <ashton.wiersdorf@pobox.com> | 2023-01-02 22:06:27 -0700 |
---|---|---|
committer | Ashton Wiersdorf <ashton.wiersdorf@pobox.com> | 2023-01-02 22:06:27 -0700 |
commit | f7e327261bb4e36100d466efc86fa5513d4e4876 (patch) | |
tree | a8d3ece8ebf49f0cf7e4761612754859ecd914f3 /README.md | |
parent | 7a0807353e9e75b9a296da8a24485254ae245cfc (diff) |
Lots of additions to README
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 61 |
1 files changed, 61 insertions, 0 deletions
@@ -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 |