emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update README

Browse source
This commit is contained in:
Henrik Lissner 2015-06-02 02:55:07 -04:00
parent c0d18776ec
commit d378d00f42
1 changed files with 34 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

48
README.md
View file

@ -1,35 +1,55 @@
# My emacs.d # NARF Emacs
![Screenshot](screenshot.png) ![Screenshot](screenshots/01.png)
> What we do every night, Pinky... > What we do every night, Pinky...
This is emacs for the stubborn vimmer, and then some. 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.
This distro is primarily for Emacs 24.5+ users on OSX, but should work for This has only been tested on Emacs 24.5 on OSX, YMMV.
debian derivative linux distros.
Any contributions or suggestions are welcome. The world won't take over itself.
## Installation ## Installation
`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:
```sh ```sh
brew tap railwaycat/emacsmacport brew tap railwaycat/emacsmacport
brew install emacs-mac --cocoa --with-imagemagick --with-gnutls brew install emacs-mac
brew install cask ```
Lastly, a recursive clone will get everything you need:
```
git clone --recursive https://github.com/hlissner/emacs.d ~/.emacs.d git clone --recursive https://github.com/hlissner/emacs.d ~/.emacs.d
cd ~/.emacs.d cd ~/.emacs.d
make make # installs plugins via cask and generates autoloads
make compile # optional
``` ```
## Customization ## Features
See: A summary of what to expect can be found in these three files:
``` ```
./Cask # for packages in this distro ./Cask # what packages are included
./init/my-commands.el # for all custom ex commands ./init/narf-commands.el # what custom ex commands are defined
./init/my-bindings.el # for all keybindings ./init/narf-bindings.el # the keybindings
./init/init-*.el # for all package settings
``` ```
## Disclaimer
I am not an elisp guru. You have been warned.
## What about Windo- ## What about Windo-
![Windows, you say...](http://i3.kym-cdn.com/photos/images/newsfeed/000/549/293/504.gif) ![Windows, you say...](http://i3.kym-cdn.com/photos/images/newsfeed/000/549/293/504.gif)