admiralakber / simplemacs

Simply emacs and a few useful packages so you can get on with it.

simplemacs, nothing complex.

Introduction

Simplemacs is the configuration you give your keen newbie hacker friend when introducing them the wonderful world of emacs.

Simplemacs is the configuration you use when you just want to GTD.

Ugh, yet another emacs configuration I hear you say, and yes I can’t deny that. Let me place this one relative to others with a table:

	Small / Simple	Large / Complex
Neat	simplemacs	oh-my-emacs, spacemacs
Messy	old mate’s dotfiles	.emacs bankrupt

It’s basically old mate’s dotfiles, where old mate is obsessive about neat code, loves org-mode, and minimalism. The entire repository should be self documenting, and concise. Have a browse!

Quick start

Step zero

Install emacs version > 24.4

Step one

Back up your existing stuff and clone it in.

mv ~/.emacs.d ~/.emacs.d.bak
git clone https://github.com/admiralakber/simplemacs ~/.emacs.d

Step two

If you want to use notmuch in emacs, be sure to edit modules/notmuch.org and uncomment the region in init.el

Step three

Run emacs.

If it doesn’t work, try run M-x list-packages to update the cache, and open emacs again.

(Optional) Step four

Install the included helper script emc into your $PATH.

You can then call this to use emacs in client / daemon mode transparently.

The so called “modules”

Simplemacs makes no attempt to create a unified configuration wrapper or anything like that. It’s emacs configuration by the UNIX Philosophy, find the appropriate file for the package and edit it yourself.

File	Requires	Notes
init.el	None	Start here
modules/package.org	None	Package management
modules/org.org	None	Beloved Org mode
modules/aesthetics.org	None	Theme to your taste here
modules/notmuch.org	notmuch	Email (edit me!)
modules/helm.org	None	Minibuffer completion
modules/company.org	None	Buffer completion
modules/yasnippet.org	None	Quick templates
modules/flyspell.org	None	Spell checking
modules/flycheck.org	None	Syntax / Style checking

The so called “activities”

I have extended the modules outline to include “activities”. This is for activity specific configuration.

File	Requires	Notes
modules/activities/programming.org	None	Minor modes

Contributing ♥

Be kind. Make issues / forks. Pull requests encouraged, even if it’s just removing whitespaces or fixing grammar.