Rewrite README
This commit is contained in:
Henrik Lissner
parent
7b39d4a94e
commit
5017fc9c3b
1 changed files with 16 additions and 79 deletions
95
README.md
95
README.md
|
|
@ -6,18 +6,13 @@
|
|||
This is an Emacs configuration for stubborn vimmers and megalomaniacal mice alike. It
|
||||
strives to emulate vim as best it can, and surpass it in any way possible.
|
||||
|
||||
It is tailored to my needs as an software developer (app, game, and web), data scientist,
|
||||
and writer running OSX and Emacs **24.5+**.
|
||||
|
||||
(For more screenshots, see the screenshots branch)
|
||||
|
||||
## Installation
|
||||
|
||||
```
|
||||
brew install cask
|
||||
brew tap railwaycat/emacsmacport
|
||||
brew install emacs-mac --with-imagemagick --with-modern-icon
|
||||
git clone --depth 1 https://github.com/hlissner/.emacs.d ~/.emacs.d
|
||||
git clone https://github.com/hlissner/.emacs.d ~/.emacs.d
|
||||
cd ~/.emacs.d
|
||||
make # installs plugins via cask and generates autoloads
|
||||
```
|
||||
|
|
@ -37,11 +32,10 @@ To get a picture of what's in here, check out:
|
|||
* **[init.el](init.el)**: lists all loaded modules
|
||||
* **[private/my-bindings.el]**: most of the custom keybinds
|
||||
* **[private/my-commands.el]**: available custom ex commands
|
||||
* **[ext/Makefile](ext/Makefile)**: lists all external dependencies
|
||||
* **[ext/Makefile](ext/Makefile)**: lists external dependencies
|
||||
|
||||
### Basic
|
||||
### Highlights
|
||||
|
||||
* Modal editing with **evil-mode**
|
||||
* Pretty line numbers with **nlinum** and neckbearded hackery
|
||||
* Syntax checking with **Flycheck**
|
||||
* Completion with **company-mode**
|
||||
|
|
@ -51,93 +45,36 @@ To get a picture of what's in here, check out:
|
|||
* Project-wide search and replace with **helm-ag** (press shift-Tab while in results
|
||||
buffer)
|
||||
* Session persistence (and tab emulation) with **workgroups2**
|
||||
|
||||
* Run code inline with **quickrun**
|
||||
* On-demand REPLs for many major modes with **repl-toggle**, including Ruby, Python,
|
||||
* REPLs for many major modes with **repl-toggle**, including Ruby, Python,
|
||||
PHP, JS, Elisp, Haskell and Lua.
|
||||
* 2-char searching with **evil-snipe**
|
||||
* Display diffs in the margin with **git-gutter**
|
||||
* 2-char motions with **evil-snipe**
|
||||
* Diffs in the margin with **git-gutter**
|
||||
* Repeat (most) motions with <kbd>SPC</kbd>
|
||||
* Snippet expansion with **yasnippet**
|
||||
* Snippet expansion with **yasnippet** and **auto-yasnippet**
|
||||
* File template support with **auto-insert** and **yasnippet**
|
||||
* Code folding with **hideshow**; doesn't allow arbitrary folds though
|
||||
* Code folding with **hideshow**
|
||||
* Multiple cursors with **[evil-multiedit]**
|
||||
* O/S interaction functions, like **os-reveal** and **os-open-in-browser**
|
||||
* Custom TODO, FIXME and NOTE highlighting
|
||||
* **big-mode** for presentations and demonstrations
|
||||
* Tmux integration with `:t` and `:tcd` ex commands
|
||||
|
||||
### Advanced
|
||||
|
||||
* **Popup control with Shackle**: I've (mostly) tamed window popups in Emacs with Shackle
|
||||
(popwin was unstable and slow). That includes popups made by: Helm, vc-annotate,
|
||||
quickrun, neotree, \*messages\*, org-mode--and others.
|
||||
* **Ex compatibility**: I've given quite a few plugins an Ex interface. For instance, `:t
|
||||
[ARGS]` and `:tcd` for tmux, `:ag [KEYWORDS]` for helm-ag, and `:align [REGEXP]` for
|
||||
align-regexp. See [private/my-commands.el] for more.
|
||||
* **Incremental highlighting for `:g[lobal]`**: evil's stock global command does not do
|
||||
this (`:align` will also highlight matches).
|
||||
* **A multiple cursor implementation using iedit**: I could never get [evil-mc] working,
|
||||
and [multiple-cursors] doesn't play nice with evil-mode, so I wrote [evil-multiedit]. To
|
||||
use it, hop into visual mode, select a region and press <kbd>S-r</kbd> (shift-R). Your
|
||||
edits will apply to all highlighted regions. To limit iedit's scope: while in iedit mode
|
||||
go into visual, select a range and press <kbd>SPC</kbd>.
|
||||
* **Rudimentary support for extra =expand(...) symbols in evil-ex**: this includes
|
||||
`%:[pdert]`, which can be used with ex commands like `:e`, `:w`, or in the expression
|
||||
register. This *could* be truer to vim, but I haven't gotten around to it.
|
||||
* **Vim-esque Omni-completion commands**: I've implemented most of the common
|
||||
omni-completion shortcuts:
|
||||
|
||||
```
|
||||
C-x C-l 'narf/company-whole-lines
|
||||
C-x C-k 'narf/company-dict-or-keywords
|
||||
C-x C-f 'company-files
|
||||
C-x C-] 'company-tags
|
||||
C-x s 'company-ispell
|
||||
C-x C-s 'company-yasnippet
|
||||
C-x C-o 'company-semantic
|
||||
C-x C-n 'company-dabbrev-code
|
||||
C-x C-p (lambda (interactive)
|
||||
(let ((company-selection-wrap-around t))
|
||||
(call-interactively 'company-dabbrev-code)
|
||||
(company-select-previous-or-abort))))
|
||||
```
|
||||
|
||||
* **Popup REPLs**: currently supports python (ipython), ruby (pry), php (boris), elisp
|
||||
(ielm), lua, js (nodejs), haskell, and the shell. More support later, hopefully for go
|
||||
and rust.
|
||||
* **Yasnippet + auto-insert = file-templates with editable fields**: _and_ it works with
|
||||
evil-mode! See [core/core-file-templates.el](core/core-file-templates.el) for
|
||||
configuration details.
|
||||
* **Tab emulation with Workgroups2**: Workgroups2 will display the tabs in the minibuffer
|
||||
when you press <kbd>⌘-S-T</kbd> (or `:tabs`). `gt` and `gT` work as well.
|
||||
|
||||
|
||||
|
||||
⌘-1 - ⌘-9 keybindings work as well.
|
||||
|
||||
* **Minimalistic mapping macro**: I liked how concise mapping keys in viml was. I
|
||||
brought a little of that to Emacs by defining `map!`, a macro for defining keybindings
|
||||
in as little space as possible. [See my bindings](private/my-bindings.el) for an
|
||||
example.
|
||||
* Tamed popup windows with **shackle**
|
||||
* Vim-esque omnicompletion. e.g. `C-x C-f` for files
|
||||
* Quick keybindings with `:[nviom]map`
|
||||
* Emacs for modern note-taking/LaTeX/writing with **org-mode** or **rst-mode**
|
||||
* **Modeline improvements**
|
||||
* **evil-search/iedit/evil-substitute mode-line integration**: I better integrated
|
||||
Anzu, evil-search, evil-substitute (e.g. `%s/foo/bar`) and
|
||||
[evil-multiedit](https://github.com/hlissner/evil-multiedit) into the mode-line.
|
||||
* evil-search/iedit/evil-substitute mode-line integration:
|
||||
|
||||
|
||||
|
||||
* **Macro-recording indicator**:
|
||||
* Macro-recording indicator:
|
||||
|
||||
|
||||
* **Show (py|rb)env version in mode-line**: see `define-env-command!` on how to set it up
|
||||
for other modes. It only displays in their respective major-modes.
|
||||
* Show (py|rb)env version in mode-line
|
||||
|
||||
|
||||
* **Org-mode**: I do a lot with org-mode. Notetaking, CRM, GTD, blue sky thinking, you
|
||||
name it. Inline LaTeX rendering and images, org popups tamed by shackle, go/http babel
|
||||
support, a custom attachment system -- there is too much to say. Check out the various
|
||||
org modules for details.
|
||||
|
||||
|
||||
## What about Windo-
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue