Add basic README.

2013-09-02 18:26:58 +02:00 · 2013-09-02 18:26:58 +02:00 · 87b29e6123
parent 24f7ea3944
commit 87b29e6123
1 changed files with 16 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,16 @@
+window-numbering
+================
+
+Numbered window shortcuts for Emacs
+
+[![Build Status](https://travis-ci.org/nschum/window-numbering.el.png?branch=master)](https://travis-ci.org/nschum/window-numbering.el)
+
+Enable `window-numbering-mode` and use M-1 through M-0 to navigate.
+
+If you want to affect the numbers, use window-numbering-before-hook or
+window-numbering-assign-func.
+For instance, to always assign the calculator window the number 9, add the
+following to your .emacs:
+
+    (setq window-numbering-assign-func
+          (lambda () (when (equal (buffer-name) "*Calculator*") 9)))