diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 56 |
1 files changed, 40 insertions, 16 deletions
@@ -1,7 +1,7 @@ [![License GPL 3][badge-license]](http://www.gnu.org/licenses/gpl-3.0.txt) [![MELPA](http://melpa.org/packages/zenburn-theme-badge.svg)](http://melpa.org/#/zenburn-theme) [![MELPA Stable](http://stable.melpa.org/packages/zenburn-theme-badge.svg)](http://stable.melpa.org/#/zenburn-theme) -[![Gratipay](http://img.shields.io/gratipay/bbatsov.svg)](https://www.gratipay.com/bbatsov/) +[![Patreon](https://img.shields.io/badge/patreon-donate-orange.svg)](https://www.patreon.com/bbatsov) ## About @@ -12,15 +12,18 @@ that of its many users I presume) that it's one of the best low contrast color themes out there and that it is exceptionally easy on the eyes. -This theme uses the new built-in theming support available starting -with Emacs 24. +This theme uses the "new" (it used to be new several years ago when I +created this package) built-in theming support available starting with +Emacs 24.1. + +![Overview screenshot](screenshots/overview.png) ## Installation ### Manual Download `zenburn-theme.el` to the directory `~/.emacs.d/themes/`. Add this to your -`.emacs`: +`.emacs` (or `init.el`): ```lisp (add-to-list 'custom-theme-load-path "~/.emacs.d/themes/") @@ -60,6 +63,8 @@ Users of Debian 9 or later or Ubuntu 16.10 or later may simply ## Customization +### Custom colors + If you'd like to tweak the theme by changing just a few colors, you can do so by defining new values in the `zenburn-override-colors-alist` variable before loading the theme. @@ -68,17 +73,40 @@ For example, to customize just the lighter background colors, you could add to your init file: ```elisp -(defvar zenburn-override-colors-alist - '(("zenburn-bg+05" . "#282828") - ("zenburn-bg+1" . "#2F2F2F") - ("zenburn-bg+2" . "#3F3F3F") - ("zenburn-bg+3" . "#4F4F4F"))) +(setq zenburn-override-colors-alist + '(("zenburn-bg+05" . "#282828") + ("zenburn-bg+1" . "#2F2F2F") + ("zenburn-bg+2" . "#3F3F3F") + ("zenburn-bg+3" . "#4F4F4F"))) (load-theme 'zenburn t) ``` To see the full list of color names you can override, consult the `zenburn-theme.el` source file. +### Scaled headings + +The theme supports scaling the font size for some headings and titles as well +as using a variable-pitch font for those. To enable this, use the following +settings: + +```elisp +;; use variable-pitch fonts for some headings and titles +(setq zenburn-use-variable-pitch t) + +;; scale headings in org-mode +(setq zenburn-scale-org-headlines t) + +;; scale headings in outline-mode +(setq zenburn-scale-outline-headlines t) +``` + +The screenshot above shows the default setting with no scaled or +variable-pitch fonts. With scaled headings and variable-pitch fonts it looks +like this: + +![Scaled screenshot](screenshots/scaled.png) + ## Ugly colors in the terminal Emacs version If your Emacs looks considerably uglier in a terminal (compared to the @@ -92,17 +120,13 @@ Source the `.bashrc` (or `.zshrc`) file and start Emacs again. # Bugs & Improvements -Please, report any problems that you find on the projects integrated +Please, report any problems that you find on the project's 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. [These](https://github.com/bbatsov/zenburn-emacs/contributors) contributors have done so. -You can support my work on Zenburn and [all my other projects](https://github.com/bbatsov) via [gratipay](https://www.gratipay.com/bbatsov). - -[![Support via Gratipay](https://cdn.rawgit.com/gratipay/gratipay-badge/2.1.3/dist/gratipay.png)](https://gratipay.com/bbatsov) - -Cheers,<br\> -[Bozhidar](http://twitter.com/bbatsov) +You can support my work on Zenburn and [all my other projects](https://github.com/bbatsov) +via [Patreon](https://www.patreon.com/bbatsov). [badge-license]: https://img.shields.io/badge/license-GPL_3-green.svg |