solaryzed-emacs/README.md
Yann Esposito (Yogsototh) 955e791142
forgot some rename
2019-10-18 23:49:40 +02:00

139 lines
4.6 KiB
Markdown

[![License GPL 3][badge-license]](http://www.gnu.org/licenses/gpl-3.0.txt)
[![MELPA](http://melpa.org/packages/solaryzed-theme-badge.svg)](http://melpa.org/#/solaryzed-theme)
[![MELPA Stable](http://stable.melpa.org/packages/solaryzed-theme-badge.svg)](http://stable.melpa.org/#/solaryzed-theme)
[![Join the chat at https://gitter.im/bbatsov/solaryzed-emacs](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/bbatsov/solaryzed-emacs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
# Solaryzed for Emacs
Solaryzed for Emacs is an Emacs port of the [Solaryzed theme for vim](http://ethanschoonover.com/solaryzed),
developed by Ethan Schoonover.
You can find several screenshots of Solaryzed for Emacs [here](https://emacsthemes.com/themes/solaryzed-themes.html).
Solaryzed 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
Solaryzed for Emacs is available for installation via the
[MELPA](http://melpa.org) `package.el`
repository. Assuming you've set it up you can install Solaryzed like this:
`M-x package-install solaryzed-theme`
This package will install two variants of the theme - `solaryzed-light-theme`
and `solaryzed-dark-theme`. You can load one of the theme variants with `M-x
load-theme`.
To load it automatically on Emacs startup add this to your init file:
```el
(load-theme 'solaryzed-light t)
```
or
```el
(load-theme 'solaryzed-dark t)
```
(If you want to install manually that procedure is briefly documented in the
FAQ at the end of this document.)
## Customisations
### Theme specific settings
If you don't like low-contrast modeline or fringe, you can `customize` them
either by doing `M-x customize-group solaryzed` or setting the values using
elisp code:
```el
;; make the fringe stand out from the background
(setq solaryzed-distinct-fringe-background t)
;; Don't change the font for some headings and titles
(setq solaryzed-use-variable-pitch nil)
;; make the modeline high contrast
(setq solaryzed-high-contrast-mode-line t)
;; Use less bolding
(setq solaryzed-use-less-bold t)
;; Use more italics
(setq solaryzed-use-more-italic t)
;; Use less colors for indicators such as git:gutter, flycheck and similar
(setq solaryzed-emphasize-indicators nil)
;; Don't change size of org-mode headlines (but keep other size-changes)
(setq solaryzed-scale-org-headlines nil)
;; Avoid all font-size changes
(setq solaryzed-height-minus-1 1.0)
(setq solaryzed-height-plus-1 1.0)
(setq solaryzed-height-plus-2 1.0)
(setq solaryzed-height-plus-3 1.0)
(setq solaryzed-height-plus-4 1.0)
```
Note that these need to be set **before** `load-theme` is invoked for Solaryzed.
### Underline position setting for X
If you are using Emacs under X you might like the following setting which puts
the underline below the
[font bottomline instead of the baseline](https://publib.boulder.ibm.com/infocenter/pseries/v5r3/topic/com.ibm.aix.graPHIGS/doc/phigstrf/figures/afma5rbd.jpg).
Imho it enhances the general readability and also it fits well with the default
`solaryzed-high-contrast-mode-line` setting which uses an slightly emphazised
underline for the modeline to create one horizontal window border in the same
manner as the vertical border.
```el
(setq x-underline-at-descent-line t)
```
## 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.
## FAQ
### Stand-alone manual installation
Save the following files in a folder that's on your Emacs' `load-path`:
* [dash.el](https://raw.githubusercontent.com/magnars/dash.el/master/dash.el) - [dash](https://github.com/magnars/dash.el), a modern list library for Emacs
* [solaryzed.el](https://raw.githubusercontent.com/bbatsov/solaryzed-emacs/master/solaryzed.el) - the solaryzed theme
Save the following files into `~/.emacs.d/themes`:
* [solaryzed-light-theme.el](https://raw.githubusercontent.com/bbatsov/solaryzed-emacs/master/solaryzed-light-theme.el)
* [solaryzed-dark-theme.el](https://raw.githubusercontent.com/bbatsov/solaryzed-emacs/master/solaryzed-dark-theme.el)
Add this your `.emacs.d`:
```el
(add-to-list 'custom-theme-load-path "~/.emacs.d/themes")
```
Now you can load the theme with the interactive function `load-theme`.
## Contributors
- [Thomas Frössman](http://t.jossystem.se)
(Add yourself to the list)
Cheers,<br\>
[Bozhidar](http://twitter.com/bbatsov)
[badge-license]: https://img.shields.io/badge/license-GPL_3-green.svg