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 2017-04-08 02:46:20 -04:00
parent a30b75a550
commit 1746a80c83
1 changed files with 22 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

46
README.md
View file

@ -8,13 +8,13 @@
<img src="https://raw.githubusercontent.com/hlissner/.emacs.d/screenshots/cacochan.png" align="right" /> <img src="https://raw.githubusercontent.com/hlissner/.emacs.d/screenshots/cacochan.png" align="right" />
</a> </a>
This is an Emacs configuration for a stubborn, melodramatic and This is an Emacs configuration for a stubborn, melodramatic and shell-dwelling
shell-dwelling vimmer disappointed with the text-editor status quo. vimmer disappointed with the text-editor status quo.
Doom tries to look and act like modern editors (whatever that means to Doom tries to look and act like modern editors (whatever that means to me on any
me on any given day), espouse vim's modal philosophy as best it can and strive given day), espouse vim's modal philosophy as best it can, and strive to surpass
to surpass vim in any way possible, and generally fit my needs as a software vim in any way possible. It fits my needs as a software developer, indie game
developer, indie game developer, scientist and doom enthusiast. developer, scientist and doom enthusiast.
It was tailored for **MacOS 10.11+** and **Arch Linux 4.7+**, and It was tailored for **MacOS 10.11+** and **Arch Linux 4.7+**, and
**exclusively** for Emacs 25.1+. I use [vim] everywhere else. **exclusively** for Emacs 25.1+. I use [vim] everywhere else.
@ -42,23 +42,21 @@ make autoloads # or (doom/reload-autoloads)
To get a picture of what's in here, check out: To get a picture of what's in here, check out:
* **[init.example.el](init.example.el)**: what my loadout looks like. * **[init.example.el](init.example.el)**: what my loadout looks like.
* **[modules/README.md](modules/README.md)**: a primer into module * **[modules/README.md](modules/README.md)**: a primer into module structure and
structure and how the module system works. how the module system works.
* **[modules/private/hlissner/+bindings.el](modules/private/hlissner/+bindings.el)**: * **[modules/private/hlissner/+bindings.el](modules/private/hlissner/+bindings.el)**:
my custom keybinds. my custom keybinds.
* **[modules/private/hlissner/+commands.el](modules/private/hlissner/+commands.el)**: * **[modules/private/hlissner/+commands.el](modules/private/hlissner/+commands.el)**:
my custom ex commands. my custom ex commands.
* **[modules/ui](modules/ui)**: the modules that makes my Emacs look * **[modules/ui](modules/ui)**: the modules that makes my Emacs look the way it
the way it does, including [my theme][doom-theme], modeline, does, including [my theme][doom-theme], modeline, dashboard and more.
dashboard and more.
+ Find screenshots in the [screenshots branch][sc]. + Find screenshots in the [screenshots branch][sc].
### Highlights ### Highlights
* A [popup management system](core/core-popups.el) using **[shackle]** * A [popup management system](core/core-popups.el) using **[shackle]** for
for temporary or disposable buffers. temporary or disposable buffers.
* Workspaces, tab emulation & session persistence with * Workspaces, tab emulation & session persistence with **[persp-mode]**.
**[persp-mode]**.
* Project and workspace-restricted buffer navigation and functions. * Project and workspace-restricted buffer navigation and functions.
* A vim-centric environment with **[evil-mode]** * A vim-centric environment with **[evil-mode]**
* 2-character motions (ala vim-seek/vim-sneak) with **[evil-snipe]** * 2-character motions (ala vim-seek/vim-sneak) with **[evil-snipe]**
@ -73,13 +71,13 @@ To get a picture of what's in here, check out:
* Project search (& replace) with **[counsel-ag]** (and **[wgrep]**) * Project search (& replace) with **[counsel-ag]** (and **[wgrep]**)
* Interactive buffer search with **[swiper]** * Interactive buffer search with **[swiper]**
* REPLs & inline/live code evaluation (using **[quickrun]** and * REPLs & inline/live code evaluation (using **[quickrun]** and
**[repl-toggle]**) for many languages including Ruby, Python, PHP, **[repl-toggle]**) for many languages including Ruby, Python, PHP, JS, Elisp,
JS, Elisp, Haskell and Lua. Haskell and Lua.
* [Minimalistic diffs in the fringe][sc-diffs] with **[git-gutter-fringe]**. * [Minimalistic diffs in the fringe][sc-diffs] with **[git-gutter-fringe]**.
* A do-what-I-mean jump-to-definition implementation that tries its * A do-what-I-mean jump-to-definition implementation that tries its darnest to
darnest to find the definition of what you're looking at. It tries find the definition of what you're looking at. It tries major-mode commands,
major-mode commands, xref (experimental Emacs library) xref (experimental Emacs library) **[dumb-jump]**, ctags (WIP), then
**[dumb-jump]**, ctags (WIP), then **[counsel-ag]**. **[counsel-ag]**.
* Snippets and file-templates with **[yasnippet]**. * Snippets and file-templates with **[yasnippet]**.
* A smarter, perdier, Atom-inspired mode-line that includes: * A smarter, perdier, Atom-inspired mode-line that includes:
* evil-search/iedit/evil-substitute mode-line integration * evil-search/iedit/evil-substitute mode-line integration
@ -88,9 +86,9 @@ To get a picture of what's in here, check out:
## Contributing or troubleshooting ## Contributing or troubleshooting
My config wasn't intended for public use, but I'm happy to help you My config wasn't intended for public use, but I'm happy to help you use or crib
use or crib from my config and I welcome contributions of any kind; from my config. I welcome contributions of any kind; documentation, bug fixes,
documentation, bug fixes or even elisp tips. even elisp tips.
[Don't hesitate to report bugs or tell me my Elisp-fu sucks](https://github.com/hlissner/.emacs.d/issues/new)! [Don't hesitate to report bugs or tell me my Elisp-fu sucks](https://github.com/hlissner/.emacs.d/issues/new)!