summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Polden <mpolden@mpolden.no>2020-04-22 22:09:31 +0200
committerMartin Polden <mpolden@mpolden.no>2020-04-22 22:16:53 +0200
commit202c1bc0be0df93f703afffd60a53335aeb80c87 (patch)
tree23c49c4d0574e2c144e029c4fd466d1e30f69bcc
parentb50f9318a64dd1b130b762f68bb8da2f45ace717 (diff)
Update readme
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
index ce2543d..a4a205d 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,36 @@ My personal Emacs settings with inspiration from:
* [purcell/emacs.d](https://github.com/purcell/emacs.d)
* [technomancy/better-defaults](https://github.com/technomancy/better-defaults)
+## Considerations
+
+This `emacs.d` makes Emacs into a highly productive editor for me. I try to keep
+the following in mind when maintaining it:
+
+* Let Emacs be Emacs. Don't attempt to transform it into another editor.
+* Keep the configuration as small as possible.
+* Improve upon unusable default settings.
+* Build the configuration from scratch. Avoid Emacs distributions such as
+ [syl20bnr/spacemacs](https://github.com/syl20bnr/spacemacs),
+ [bbatsov/prelude](https://github.com/bbatsov/prelude) or
+ [hlissner/doom-emacs](https://github.com/hlissner/doom-emacs). This is not a
+ comment on the quality or purpose of such distributions, they're just not
+ for me.
+* Keep the number of external packages to a minimum.
+ * Eschew heavy-weight packages that fundamentally change how Emacs works.
+ * Prefer packages that compose well with the rest of Emacs.
+* Try to unify keybindings across similar modes (e.g. `o` and `C-o` in `dired`
+ and `grep`). Keybindings can be notoriously inconsistent across modes.
+* Be vigilant in throwing away keybindings, packages or other configuration that
+ remains unused for long periods.
+* Don't complicate `org-mode` too much. I use `org` to manage much of my life
+ and a minimum configuration exists to accomplish this.
+ * Avoid additional `org` packages as `org` itself is more than big enough.
+* Make code navigation quick and easy.
+ * Most non-trivial code repositories contain many source files and
+ navigating them efficiently is key to my productivity.
+* Don't take on too many responsibilities. I.e. I have tried and failed to use
+ Emacs for email and RSS.
+
## Setup
Clone the repository: