From 98ccec5e8ad0e9369c786717ce87badf9e5060c3 Mon Sep 17 00:00:00 2001 From: Jim Myhrberg Date: Sun, 4 Oct 2015 09:32:21 +0100 Subject: [PATCH] Add readme --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1b3eae7 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# jimeh's .emacs.d (a.k.a. Emacs-Siren) + +This is my personal Emacs config, currently nicknamed Emacs-Siren, and heavily +inspired by [Emacs Prelude](https://github.com/bbatsov/prelude). + +However, this is not some form of an Emacs starter kit, it's simply my personal +config with any quirks, oddities, bugs, and man-eating errors I live with on a +daily basis. + +## Requirements + +- Emacs 24.5 or later. Earlier versions might work, but I haven't tested them. + +## Installation + +1. Clone the repo to `~/.emacs.d`, and update git submodules: + + git clone git://github.com/jimeh/.emacs.d.git ~/.emacs.d + cd ~/.emacs.d + git submodule init + git submodule update + +2. Launch Emacs and wait a few minutes while it installs all missing packages. +3. Enjoy ^_^