This repository contains the setup I use to customize Emacs. The configuration uses an Org-Babel setup I use to store my initialization file as an Org Mode file, and the corresponding init.el that bootstraps the system.
My emacs configuration uses the .emacs.d directory since it contains several files. There are several other packages it relies on to work. Rather than include them directly in the repository, this repository contains submodules that point to them. Before you begin, make sure you don’t have a .emacs file or a .emacs.d directory already set up; they’ll get in the way of setting everything up. It takes three steps to configure the repository:
- Check out the repository using git into the directory of your choosing
- Navigate to the
emacs-configdirectory and run two commands:git submodule initgit submodule update
- Symlink the
emacs-configdirectory to~/.emacs.d
Start up Emacs and test out the new configuration, and edit the emacs.org file as desired.
GitHub actually uses a Ruby gem called Org-Ruby to handle org files, and Org-Ruby doesn’t handle code blocks nearly as well as the elisp version does. For that reason, if you choose to view the repository on GitHub, I recommend viewing the file in raw mode, since the source code will otherwise be somewhat mangled.
Alternatively, you can see a quite-up-to-date HTML export of the org file at Etherplex.