greaber / ohai-emacs

The finest hand crafted artisanal emacs.d for your editing pleasure

Ohai Emacs

While it is certainly true that Emacs is the most powerful text editor in the world, your first impression of it may be less favourable, because its default configuration really just isn’t all that great.

But now there is Ohai Emacs! Simply install Ohai Emacs as your emacs.d, and you will be ready to bask in the full radiance of Holy Emacs in no time at all.

There is even a configuration wizard!

Installation

If you don’t have it installed already, go get a copy of GNU Emacs version 24.4 or later.

If you have an emacs.d already, move it out of the way (mv ~/.emacs.d ~/.emacs.d.bak) or get rid of it (rm -rf ~/.emacs.d) first.

To download Ohai Emacs as your new emacs.d:

$ git clone https://github.com/bodil/ohai-emacs.git ~/.emacs.d

That’s it! Now, the next time you start Emacs, Ohai Emacs will ask you a few questions about how you like things to be, and go on the internets and download some fresh packages for you. In a little while, it will be ready for your emacsing.

Usage

A full feature list is pending. A quick overview:

• Carefully styled for a fashionable look.
• Improved navigation, editing and code style settings.
• Magit, the premier git frontend.
• Smart autocomplete with company-mode.
• Flycheck.
• Yasnippet.
• Paredit for Emacs Lisp.
• Improved JS and HTML modes with powerful refactoring tools.
• Nyan Cat.

Learning From Emacs Lisp

While Ohai Emacs helps you get started quickly and without frustration, you must eventually learn Emacs Lisp in order to become an Emacs Master. The Ohai Emacs source code contains numerous comments designed to explain, often in detail, what it’s doing. The best (if not the fastest) way to learn what Ohai Emacs can do for you is to read the source.

Start at .emacs.d/init.el. This sets up the basic environment, and loads each Ohai Emacs module from the .emacs.d/modules directory in turn. Read through the .el file in the module directory that are of interest to you, and you will find they explain the changes they make, often pointing you to useful documentation for the more powerful features.

License

Copyright 2015 Bodil Stokke

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.