Warning

• I'm using Vim key binding. Please see "Tips" section if you prefer the Emacs key binding.
• People in Mainland China may need goagent to download packages from ELPA. Run command "http_proxy=http://127.0.0.1:8087 emacs -nw" after starting goagent server.
• C++/C developers, you need tell Emacs where to search headers to make auto-complete work. See section clang for details.
• For Windows users, I would suggest Cygwin Emacs instead of native one to avoid some overhead on set up third party tools. But this configuration is still usable even with native windows Emacs.
• I whitelist packages on melpa because packages in melpa is kind of too cutting edge. Modify variable "melpa-include-packages" in init-elpa.el if you want add new package into that whitelist.

General

This configuration is originally cloned from Steve Purcell's emacs.d.

My first priority is stable. So I use fewer cutting-edge packages from melpa than average geeks. Average geeks use 500 packages, I have only installed 200 packages. ;)

To install, Download this zip file and extract its content into ~/.emacs.d. Ensure that the 'init.el' contained in this repo ends up at /.emacs.d/init.el and old */.emacs does NOT exist*.

Thanks to Purcell, this emacs.d has fancy features for most script languages like Clojure, Python, Lisp, PHP, Javascript, Ruby etc. Purcell is basically a web geek who use all the modern web technologies.

I will support all the languages a desktop application developer use, like C++, Java, Lua, Objective-C etc.

Features

• Real time HTML syntax checker enabled (you need install tidy)
• git or subversion is NOT needed. I removed all the 'git submodule update' stuff.
• optimized for cross-platform C++ development with CMake and wxWidgets
• emacs-w3m (console browser)
• eim (Chinese pinyin input method)
• org2blog (post wordpress blog with org-mode)
• make the configuration work on ALL platforms (Linux/Cygwin/Mac). BTW, when I say Linux, I mean all the popular distributions (Debian, Ubuntu, Mint, Centos, ArchLinux, Gentoo ...).
• The configuration will work with Emacs version >=24 but still usable with Emacs version 23 (tested with Emacs 23.4.1).
• evil-mode and its plugins (Vim key binding)
• yasnippet and my customized snippets (insert code snippet by typing less keys)

Third party tools Emacs uses

They are OPTIONAL. Your Emacs will NOT crash if they are not installed.

w3m (web browser in console)

• needed by w3m (w3m is emacs package name written in elisp)
• install by OS way

lua

• required by flymake-lua
• install by OS way

aspell or hunspell (RECOMMENDED), and corresponding dictionary (aspell-en, for example)

• needed by flyspell
• hunspell is the alternative of aspell. So you need only install either aspell or hunspell.
• install by OS way
• I force the dictionary to "en_US" in init-spelling.el. You can modify it in init-spelling.el.

sbcl (lisp environment)

• needed by lisp slime
• install by OS way

tidy (html tidy program)

• needed by web-mode for real time HTML syntax check
• install by OS way

csslint

• install node.js by OS way, then sudo npm install -g csslint

zip and unzip

• needed by org-mode to export org to odt
• install by OS way

xsel

• needed by my clipboard command copy-to-x-clipboard and paste-from-x-clipboard under Linux
• install by OS way

clang (http://clang.llvm.org)

• needed by cpputils-cmake, flymake, company-clang
• install by OS way
• If you use company-clang (default), add (setq company-clang-arguments '("-I/example1/dir" "-I/example2/dir")) into ~/.emacs.d/init.el
• If you use cpputils-cmake and cmake, cpputils-cmake will do all the set up for you.

MozRepl firefox addon (https://addons.mozilla.org/en-us/firefox/addon/mozrepl/)

• needed by MozRepl
• install using firefox

ctags (http://ctags.sourceforge.net)

• needed by many tags related plugins
• install by OS way

GNU Global (http://www.gnu.org/software/global)

• needed by gtags
• You use this tool to navigate the C/C++/Java/Objective-C code.
• install by OS way

pyflakes

• You need pyflakes for real time python syntax checker like flymake-python
• Install pip by OS way, then pip install pyflakes
• On cygwin you need install setuptool in order to install pip.

libreoffice

• Only one of its binary soffice is needed
• needed when converting odt file into doc (Microsoft Word 97)
• conversion will happen automatically when exporting org-mode to odt
• The conversion command is stored in variable org-export-odt-convert-processes
• Install by OS way

ditaa, grapviz and planetuml to convert ascii art to diagram and uml.

I don't use them now.

How to install by OS way

• apt-cyg at Cygwin
• homebrew at Mac
• any package manager at Linux

Report bug

If you find any bug, please file an issue on the github project: https://github.com/redguardtoo/emacs.d

Tips

• By default EVIL (Vim emulation in Emacs) is used. You can comment out line containing "(require 'init-evil)" in init.el to unload it.

• Some package cannot be downloaded automatically because of network problem. You need manually M-x list-packages and install it.

• You can speed up the start up by NOT loading some heavy weight components like evil or yasnippet. All you need to do is add below code into ~/.bashrc:

  alias e=emacs -q --no-splash --eval="(setq light-weight-emacs t)" -l "$HOME/.emacs.d/init.el"

• If you use gnus for email thing (Gmail, for example). Check ~/.emacs.d/init-gnus.el which includes my most settings except my private stuff. There is also a tutorial at my blog on how to use gnus effectively.

• To toggle Chinese input method (eim, for example), press C-\ or run command M-x toggle-input-method.

My personal custom.el (OPTIONAL)

It's publicized at http://blog.binchen.org/?p=430. It contains my personal stuff like color-theme and time locale.

---