Initial import.

[BTCSB-theme.git] / README.md

diff --git a/README.md b/README.md
index 58a482d..61e59a1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,24 @@
-BTCSB-emacs-theme
-=================
+# Baby, The Code Shines Bright
 
-Ultra kawaii Emacs theme
\ No newline at end of file
+This is an Emacs adaptation of
+[Jessica Allen's TextMate theme of the same name][1], which is in turn
+a TextMate adaptation of [frilly dresses][3]. Because Emacs and
+TextMate have slightly different views on how to fontify source code,
+it doesn't look exactly the same, but I think it has the same spirit.
+
+It uses the new Emacs 24 theming capabilities, and not the old
+`color-theme` interface. To use it, just dump it in your `~/.emacs.d`
+and add something like
+
+    (load-theme 'BTCSB t)
+
+to your `~/.emacs`. Make sure to disable any `color-theme`-based
+theming you may have been using previously because if put in the same
+buffer they will fight in uncute ways.
+
+For more help with the new Emacs theming method,
+[Bozhidar Batsov has a quick overview of the new interface][2].
+
+  [1]: http://spacekat.github.com/blog/2010/08/26/cute-code-overload/
+  [2]: http://batsov.com/articles/2012/02/19/color-theming-in-emacs-reloaded/
+  [3]: http://www.babyssb.co.jp/