summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBozhidar Batsov <lordbad@gmail.com>2010-09-19 14:36:01 +0300
committerBozhidar Batsov <lordbad@gmail.com>2010-09-19 14:36:01 +0300
commit178dd7d35eda50a64450fd4735a221500b295a69 (patch)
tree67a6dbc86e0ca108cc766ed0c0308c555a24b8a4 /README.md
parentb8b78180c386eee41bacb2c359a2d9ed5163cca2 (diff)
some docs & improvements
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
index e69de29..d1cb016 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,28 @@
+# About #
+
+Zenburn for Emacs is a direct port of the popular
+[http://slinky.imukuppi.org/zenburnpage/ Zenburn] theme for vim,
+developed originally by Jani Nurminen. It's my personal belief(and
+that of many of its users I presume) that it's one of the best low
+contrast themes out there and that Zenburn is exceptionally easy on
+the eyes.
+
+The project was originally ported to Emacs by Daniel Brockman, but it
+seems that he has lost interest in it recently. This is the reason why
+I gathered here all improvements over the last official Zenburn
+version and started this fork of the project. It's my hope that it
+will be become a central place for zenburn development.
+
+# Installation #
+
+Zenburn depends on the color-theme package, so you should have it
+installed. After that just put this in your .emacs(or equivalent):
+
+`(require 'zenburn)`
+
+# Bugs & Improvements #
+
+Please, report any problems that you find on the projects integrated
+issue tracker. If you've added some improvements and you want them
+included upstream don't hesitate to send me a patch or even better - a
+GitHub pull request.