diff --git a/README.md b/README.md index d4df3cb34..75703df90 100644 --- a/README.md +++ b/README.md @@ -4,33 +4,21 @@ > What we do every night, Pinky... -This is emacs for the stubborn vimmer, megalomaniac mouse and/or masochists -alike. It has been configured first: to emulate vim as best it can, and second: -to surpass it in any way possible. Narf uses -[Evil-mode](https://gitorious.org/evil/pages/Home), a vim-emulator for emacs, to -accomplish this. +This is Emacs for stubborn vimmers and megalomaniac mice alike. Its goals are: +first, to emulate vim as best it can, and second, surpass it in any possible +way. Narf uses [Evil-mode](https://gitorious.org/evil/pages/Home) to emulate +vim, Cask to manage plugins, and a slew of jury-rigged neckbeard shenanigans to +to keep my mountain dew cool. -This has only seen testing on Emacs 24.5 in OSX. YMMV. +It is tailored for the Emacs 24.5+ OSX users and sub-sub-sub-basement dwellers. Any contributions or suggestions are welcome. The world won't take over itself. ## Installation -`brew install cask` - -Narf uses [Cask](https://github.com/cask/cask) to manage plugins. - -Also, though not strictly a requirement, I recommend the railwaycat/emacsmacport -build of emacs for OSX, which you can get via homebrew: - -```sh -brew tap railwaycat/emacsmacport -brew install emacs-mac --HEAD --use-git-head --with-imagemagick --with-modern-icon -``` - -A recursive clone of this repo will get you all you need. - ``` +brew install cask +brew install railwaycat/emacsmacport/emacs-mac --HEAD --use-git-head --with-imagemagick --with-modern-icon git clone --recursive https://github.com/hlissner/emacs.d ~/.emacs.d cd ~/.emacs.d make # installs plugins via cask and generates autoloads @@ -39,13 +27,13 @@ make compile # optionally byte-compiles everything ## Features -A summary of what to expect can be found in these four files: +You'll get a good picture of what's in here from these files: ``` ./Cask # what packages are used (and where) ./init.el # lists all core files and modules loaded ./private/my-bindings.el # the keybindings -./private/my-commands.el # what custom ex commands are defined +./private/my-commands.el # available ex commands ``` ## What about Windo-