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

Improve README

Browse source
This commit is contained in:
Henrik Lissner 2016-09-09 09:00:34 +02:00
parent ea6a0d9c73
commit 33d5d0705f
1 changed files with 25 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -19,6 +19,9 @@ It was tailored for Emacs 25+ on OSX 10.11+. I use [vim] everywhere else.
## Installation ## Installation
```bash ```bash
# Ensure homebrew is up to date
brew update && brew upgrade
# Install cask + emacs # Install cask + emacs
brew install cask brew install cask
brew tap railwaycat/emacsmacport brew tap railwaycat/emacsmacport
@ -43,6 +46,7 @@ To get a picture of what's in here, check out:
* **[The Caskfile](Cask)**: lists installed plugins and where they're configured. * **[The Caskfile](Cask)**: lists installed plugins and where they're configured.
* **[init.el](init.el)**: lists all loaded modules * **[init.el](init.el)**: lists all loaded modules
* **[core/core-modeline.el](core/core-modeline.el)**: my modeline config
* **[private/my-bindings.el](private/my-bindings.el)**: most of the custom keybinds * **[private/my-bindings.el](private/my-bindings.el)**: most of the custom keybinds
* **[private/my-commands.el](private/my-commands.el)**: available custom ex commands * **[private/my-commands.el](private/my-commands.el)**: available custom ex commands
* **[ext/*.sh](ext/)**: scripts for external dependency setup (e.g. irony-mode) * **[ext/*.sh](ext/)**: scripts for external dependency setup (e.g. irony-mode)
@ -77,7 +81,7 @@ See screenshots in the [screenshots branch][sc].
bashdb and zshdb, working on Python/Ruby support) bashdb and zshdb, working on Python/Ruby support)
* A do-what-I-mean jump-to-definition implementation that either uses major-mode * A do-what-I-mean jump-to-definition implementation that either uses major-mode
commands or falls back to **[dumb-jump]**/ctags. commands or falls back to **[dumb-jump]**/ctags.
* A pretty mode-line with: * A [pretty mode-line](core/core-modeline.el) with:
* evil-search/iedit/evil-substitute mode-line integration * evil-search/iedit/evil-substitute mode-line integration
* Macro-recording indicator * Macro-recording indicator
* Python/ruby version in mode-line (for rbenv/pyenv) * Python/ruby version in mode-line (for rbenv/pyenv)
@ -93,11 +97,29 @@ See screenshots in the [screenshots branch][sc].
* Completion with **[company-mode]** * Completion with **[company-mode]**
* Syntax checking with **[flycheck]** * Syntax checking with **[flycheck]**
* Custom O/S interaction commands, like **os-reveal** and **os-open-in-browser** * Custom O/S interaction commands, like **os-reveal** and **os-open-in-browser**
* Custom TODO, FIXME and NOTE highlighting and search * Custom TODO, FIXME and NOTE highlighting and search (`:todo`)
* **big-mode** for presentations and demonstrations * **big-mode** for presentations and demonstrations (`:big`)
* Tmux integration with `:t` and `:tcd` ex commands * Tmux integration with `:t` and `:tcd` ex commands
## Troubleshooting
Though this wasn't designed with anyone else's use in mind, I'd be
happy to help anyone out with problems encountered using (or cribbing
from) my config. [Don't hesitate to report bugs](https://github.com/hlissner/.emacs.d/issues/new)!
A few things to keep in mind:
1. Cask can be flakey, especially with new builds. If you're getting
odd errors when starting up Emacs, try to run `make install` again.
I've also had cryptic cask errors that I had to reboot to resolve.
YMMV.
2. If you add new functions to any of the autoloaded
`(core|modules)/defuns/*.el` library files, `make autoloads` must
be run afterwards. `:reload` will reload Emacs' load-path if you're
running Emacs while doing so.
[auto-yasnippet]: https://melpa.org/#/auto-yasnippet [auto-yasnippet]: https://melpa.org/#/auto-yasnippet
[company-mode]: https://melpa.org/#/company [company-mode]: https://melpa.org/#/company
[counsel-ag]: https://melpa.org/#/counsel [counsel-ag]: https://melpa.org/#/counsel