branch: elpa/moe-theme
commit 35106fd49213d7992c735036a55ea581720d311c
Author: kuanyui <[email protected]>
Commit: kuanyui <[email protected]>
Update manuals.
---
README.md | 5 +++--
moe-theme.el | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++--------
2 files changed, 62 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index 83ae62b3ef..f74a6e04eb 100644
--- a/README.md
+++ b/README.md
@@ -53,9 +53,9 @@ Download the archive of `moe-theme` to `~/.emacs.d/themes`
and extract it. Then,
```
## Customizations
-It's impossible to satisfy everyone with one theme, but `moe-theme` provide
some customizations that you may like it
+It's impossible to satisfy everyone with one theme, but `moe-theme` provide
some customizations that you may like.
-Select a theme you like and go on:
+Select a theme you like and let's go on:
```lisp
(require 'moe-theme)
@@ -81,6 +81,7 @@ You may want to resize titles in `markdown-mode`, `org-mode`,
or `ReStructuredTe
(setq moe-theme-resize-org-title '(2.2 1.8 1.6 1.4 1.2 1.0 1.0 1.0 1.0))
(setq moe-theme-resize-rst-title '(2.0 1.7 1.5 1.3 1.1 1.0))
```
+
>Markdown should have 6 items; org has 9 items; rst has 6 items.
The values should be lists. Larger the values, larger the fonts.
diff --git a/moe-theme.el b/moe-theme.el
index 42bf68e630..eddb70f96e 100644
--- a/moe-theme.el
+++ b/moe-theme.el
@@ -17,21 +17,72 @@
;; https://github.com/kuanyui/moe-theme.el
;;
;;
-;; Requirements
+;; = Requirements
==============================================================
;;
;; - Emacs 24 (or above)
;; - 256 colors terminal (or higher)
;;
-;; Usage
+;; = Usage
=====================================================================
;;
;; Add you to your .emacs:
;;
-;; (load-theme 'moe-dark t)
-;; or
-;; (load-theme 'moe-light t)
+;; (require 'moe-theme)
+;; (moe-dark)
+;; or
+;; (moe-light)
;;
+;; = Customizations
============================================================
;;
-;; Auto Switching
+;; It's impossible to satisfy everyone with one theme, so `moe-theme`
provide
+;; some customizations that you may like.
+;;
+;; # Resize Titles
##########################################################
+;;
+;; You may want to resize the titles in `markdown-mode', `org-mode', or
+;; `rst-mode':
+;;
+;; (setq moe-theme-resize-markdown-title '(2.0 1.7 1.5 1.3 1.0 1.0))
+;; (setq moe-theme-resize-org-title '(2.2 1.8 1.6 1.4 1.2 1.0 1.0 1.0
1.0))
+;; (setq moe-theme-resize-rst-title '(2.0 1.7 1.5 1.3 1.1 1.0))
+;;
+;; Markdown should have 6 items; org has 9 items; rst has 6 items.
+;;
+;; The values should be lists. Larger the values, larger the fonts.
+;; If you don't like this, just leave them nil, and all the titles will be
+;; the same size.
+;;
+;; # Colorful Mode-line and Powerline
#######################################
+;;
+;; Tired of boring blue mode-line? Set default mode-line color like this:
+;;
+;; (setq moe-theme-mode-line-color 'orange)
+;;
+;; Available colors: blue, orange, magenta, yellow, purple, red, cyan, w/b.
+;;
+;; You can use `moe-theme-select-color' to change color interactively.
+;;
+;; Mayby you'll also like `moe-theme-random-color', which gives you a
+;; random mood :D.
+;;
+;; # Powerline
##############################################################
+;;
+;; Now we supports Powerline (https://github.com/milkypostman/powerline),
+;; which makes mode-line looks fabulous! We recommended installing Powerline
+;; and run `powerline-moe-theme'.
+;;
+;; ### Too Yellow Background?
###############################################
+;;
+;; With 256-colors, default yellow background of moe-light may be too yellow
+;; on some screens.
+;;
+;; If you encounter this problem, and want to set background color to
#ffffff
+;; in terminal, set the value of
`moe-light-pure-white-background-in-terminal'
+;; to t:
+;;
+;; (setq moe-light-pure-white-background-in-terminal t)
+;;
+;;
+;; = Auto Switching
============================================================
;;
;; I prefer a terminal with a black-on-white color scheme. I found that in
the
;; daytime, sunlight is strong and black-on-white is more readable; However,
@@ -41,13 +92,13 @@
;; automatically switch between moe-dark and moe-light according to the system
;; time:
;;
-;; (require 'moe-theme-switcher)
+;; (require 'moe-theme-switcher)
;;
;; By adding the line above, your Emacs will have a light theme in the day
;; and a dark one at night. =w=+
;;
;;
-;; Live in Antarctica?
+;; # Live in Antarctica?
#######################################################
;;
;; Daytime is longer in summer but shorter in winter; or you live in a high
;; latitude region which midnight-sun or polar-night may occur such as Finland