solarized-emacs

commit cfe9ad4d0c7a05c856b9955b9a688622d204bba2
parent 8e6ab0ad21ce0be791fb55bb3cd13431445d4ff9
Author: Bozhidar Batsov <bozhidar.batsov@gmail.com>
Date:   Sat,  3 Dec 2011 12:42:17 +0200

added some installation instructions

Diffstat:
D
README
 | 
0

A
README.md
 | 
44
++++++++++++++++++++++++++++++++++++++++++++

2 files changed, 44 insertions(+), 0 deletions(-)
diff --git a/README b/README
diff --git a/README.md b/README.md
@@ -0,0 +1,44 @@
+# Prelude
+
+Solarized for Emacs is an Emacs port of the [Solarized theme for vim](http://ethanschoonover.com/solarized),
+developed by Ethan Schoonover.
+
+Solarized for Emacs is tested only under Emacs 24, but should be
+working under Emacs 23 as well. The theme is implemented in terms of
+customizations and `deftheme` and does not require the
+`color-theme-package`.
+
+# Installation
+
+## Emacs Prelude
+
+Solarized for Emacs is already bundled into
+[Emacs Prelude](https://github.com/bbatsov/emacs-prelude). If you're a
+Prelude user, just do a `M-x load-theme` and pick either
+_solarized-dark_ or _solarized-light_.
+
+## Stand-alone installation
+
+Download `solarized-core.el`, `solarized-dark-theme.el` and
+`solarized-light-theme.el`.
+
+Place `solarized-core.el` is a folder that's on your Emacs' `load-path`.
+Afterward place `solarized-dark-theme.el` and
+`solarized-light-theme.el` in `~/.emacs.d/themes` (or some other
+folder if you prefer so). Add this your
+`.emacs.d`:
+
+`(add-to-list 'custom-theme-load-path "~/.emacs.d/themes")`
+
+Now you can load the theme with the interactive function `load-theme`.
+
+# 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.
+
+# Contributors
+
+So far - none. You could be the first. :-)