Oremacs config is on Github
24 Apr 2015I noticed that the packages that I've published on Github in the last year did get a nice boost in quality just from being published, viewed, used and commented on.
So it makes sense to do the same for my full Emacs config, which lives in the oremacs repository as of today.
The config is personal in the sense that I'm actually using it verbatim, but it's been configured in a way that's it's easy to replicate and modify it.
Who can benefit from this config
The audience is people like me, who like to tinker with Elisp just for fun of it. If you want things to just work, or you find learning Elisp a chore, it's not for you.
The config won't work initially, it won't work always, but when it finally does work (hopefully), it will be glorious!
Installation and Running
Requirements
Emacs 24 is required. Obviously, newer versions are better, but the
default emacs24
that you get from the package manager should work.
I'm currently switching between Emacs 24.5.2 built from source and the current master from git.
Install command
This config doesn't assume to become your main config when you install
it. It installs in-place in the git directory and will start from
there without touching your main config. But you still get access to
all your stuff, like bookmarks stored in your actual ~/.emacs.d/
etc.
cd ~/git
git clone https://github.com/abo-abo/oremacs
cd oremacs
make install
Run command
Run without updating:
make run
Run with an upstream + ELPA update:
make up
Run with an upstream + ELPA + org-mode + CEDET update:
make install
Perks
Standalone
You can try it without messing up your current Emacs config. I actually have multiple versions of this on my system to work-around incompatibility between versions. This way, I can use my full setup even in case I get a bug report for an older Emacs version.
Fast start up
With a SSD, it starts in 1 second. Most features are autoloaded and it's easy to add new autoloaded features.
Tracks the most recent org-mode and CEDET
Since these packages take a long time to byte compile, they are updated not with make up
but with make install
. They are actually git submodules, which means that they won't update if I don't update them in the upstream.
Bankruptcy-proof
It's hard to become Emacs-bankrupt with this config, since the config is composed of many independent pieces that you can simply ignore if you don't need them.
Anti-RSI QWERTY mod
The config comes with its own .Xmodmap
that makes ; into an additional modifier. RSI savers:
- ;-v instead of Enter.
- ;-o instead of Backspace.
- ;-f instead of Shift-9 and Shift-0.
- ;-a instead of -.
- ;-s instead of Shift--.
- ;-q instead of Shift-'.
- ;-e instead of =.
- ;-u in addition / instead of C-u.
And obviously the replacements for the two keys that the mod takes away:
- ;-j instead of ;.
- ;-d instead of Shift-;.
One more Elisp-level RSI-saver is the swap between C-p and C-h. Moving up/down line is very important, and it's nice to have these keys close, which C-n and C-h are.
It also includes:
- a bunch of Hydras that save you key strokes.
lispy-mode
which quickens any LISP mode, especially Elisp.worf-mode
which quickensorg-mode
.ivy-mode
which quickens all completion.swiper
which quickensisearch
(by replacing it).- C/C++ is customized with
function-args-mode
and a bunch of hacks.
Org mode starter
The config starts you off with a fully configured org-mode
setup that includes:
- gtd.org for getting things done.
- ent.org to track entertainment.
- wiki folder for quickly starting and selecting wikis.
Outro
I hope that you try and enjoy the new config. Perhaps not verbatim, but if you find the tips on this blog helpful, this config is their actual implementation that you can use for reference.