2015-06-02 14:55:07 +08:00
|
|
|
# NARF Emacs
|
2014-07-17 15:04:04 +08:00
|
|
|
|
2015-06-02 14:55:07 +08:00
|
|
|
![Screenshot](screenshots/01.png)
|
2015-05-29 10:16:25 +08:00
|
|
|
|
|
|
|
> What we do every night, Pinky...
|
|
|
|
|
2015-06-02 14:55:07 +08:00
|
|
|
This is emacs for the stubborn vimmer, megalomaniac mouse and masochists alike.
|
|
|
|
It has been configured first: to emulate vim as best it can, and second: to
|
|
|
|
surpass it in any way possible; all this is built on top of
|
|
|
|
[Evil-mode](https://gitorious.org/evil/pages/Home), a vim emulator for emacs.
|
2015-05-29 10:16:25 +08:00
|
|
|
|
2015-06-02 14:55:07 +08:00
|
|
|
This has only been tested on Emacs 24.5 on OSX, YMMV.
|
|
|
|
|
|
|
|
Any contributions or suggestions are welcome. The world won't take over itself.
|
2014-07-19 06:27:04 +08:00
|
|
|
|
2015-02-03 05:40:52 +08:00
|
|
|
## Installation
|
|
|
|
|
2015-06-02 14:55:07 +08:00
|
|
|
`brew install cask`
|
|
|
|
|
|
|
|
Narf only requires [Cask](https://github.com/cask/cask) for managing its plugins
|
|
|
|
outside of emacs.
|
|
|
|
|
|
|
|
Also, though not strictly a requirement, I recommend the railwaycat/emacsmacport
|
|
|
|
build of emacs for OSX users, which you can get via homebrew:
|
|
|
|
|
2015-02-03 05:40:52 +08:00
|
|
|
```sh
|
2015-05-29 10:16:25 +08:00
|
|
|
brew tap railwaycat/emacsmacport
|
2015-06-02 14:55:07 +08:00
|
|
|
brew install emacs-mac
|
|
|
|
```
|
|
|
|
|
|
|
|
Lastly, a recursive clone will get everything you need:
|
|
|
|
|
|
|
|
```
|
2015-02-03 05:40:52 +08:00
|
|
|
git clone --recursive https://github.com/hlissner/emacs.d ~/.emacs.d
|
2015-05-29 10:16:25 +08:00
|
|
|
cd ~/.emacs.d
|
2015-06-02 14:55:07 +08:00
|
|
|
make # installs plugins via cask and generates autoloads
|
|
|
|
make compile # optional
|
2015-02-03 05:40:52 +08:00
|
|
|
```
|
|
|
|
|
2015-06-02 14:55:07 +08:00
|
|
|
## Features
|
2015-02-03 05:40:52 +08:00
|
|
|
|
2015-06-02 14:55:07 +08:00
|
|
|
A summary of what to expect can be found in these three files:
|
2015-02-03 05:40:52 +08:00
|
|
|
|
|
|
|
```
|
2015-06-02 14:55:07 +08:00
|
|
|
./Cask # what packages are included
|
|
|
|
./init/narf-commands.el # what custom ex commands are defined
|
|
|
|
./init/narf-bindings.el # the keybindings
|
2015-02-03 05:40:52 +08:00
|
|
|
```
|
2015-05-29 10:16:25 +08:00
|
|
|
|
2015-06-02 14:55:07 +08:00
|
|
|
## Disclaimer
|
|
|
|
|
|
|
|
I am not an elisp guru. You have been warned.
|
|
|
|
|
2015-05-29 10:16:25 +08:00
|
|
|
## What about Windo-
|
|
|
|
![Windows, you say...](http://i3.kym-cdn.com/photos/images/newsfeed/000/549/293/504.gif)
|