branch: elpa/alect-themes
commit 069b437e71bdb77d4fad5e18b5da01fa28c69728
Author: Alex Kost <[email protected]>
Commit: Alex Kost <[email protected]>
Update README
---
README.md | 37 +++++++++++++++++++++++--------------
1 file changed, 23 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md
index 0545e0b..a2d9caa 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,12 @@
## About
-Alect is a package provides (rather low contrast but colourful enough)
-light and dark color themes for Emacs 24 or later. I use it only with
-GUI; terminals are not supported.
+Alect is a package that provides (rather low contrast but colourful
+enough) light and dark color themes for Emacs 24 or later. I use it
+only with GUI, so colors in terminal may look not very nice.
-At first i had only a light theme -- it was just a set of customized
+## History
+
+At first i had only a light theme – it was just a set of customized
faces. Then i realized that at night it's better for eyes to use a
dark theme (it was derived from zenburn-theme initially, but then the
colors were modified a lot). The idea of creating two themes with
@@ -25,22 +27,24 @@ Add this to your init file (`~/.emacs.d/init.el` or
`~/.emacs`):
### MELPA
-You can install `alect-themes` with [MELPA](http://melpa.milkbox.net).
-using `list-packages` or `package-install`:
-
-`M-x package-install alect-themes`
+The package can be installed from [MELPA](http://melpa.milkbox.net).
+(with `M-x package-install` or `M-x list-packages`).
-As emacs package system loads the packages after processing the init
-file, loading a theme from `.emacs` (see below) will fail because the
-path to a theme is not known yet, so you have to add the following
-code to your init file before `(load-theme ...)`:
+If you want to enable (see [Usage section](#usage)) **any** theme
+installed with a package system on Emacs start, you should know the
+following: Emacs loads packages **after** processing the init file, so
+loading a theme will fail because the path to a theme is not known
+yet. That's why you need to initialize the package system before
+loading the theme:
```lisp
(setq package-enable-at-startup nil)
(package-initialize)
+...
+(load-theme ...)
```
-For further details see emacs info: `(info "(emacs) Package Installation")`.
+For further details, see `(info "(emacs) Package Installation")`.
## Usage
@@ -48,7 +52,7 @@ To activate a theme interactively use `customize-themes` or
`load-theme`:
`M-x load-theme RET alect-light`
-To load a theme on Emacs startup add this to your init file:
+To load a theme on Emacs start, add this to your init file:
```lisp
(load-theme 'alect-light t)
@@ -59,3 +63,8 @@ To load a theme on Emacs startup add this to your init file:
+## Feedback
+
+If you use this package and want it to support a major mode the faces
+of which are not supported yet, you may send me a letter about it.
+
