docs: README

This commit is contained in:
Dylan Araps 2017-06-30 18:41:37 +10:00
parent 98190fa0df
commit 9ddf1c9758

View File

@ -2,11 +2,15 @@
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.md) [![Build Status](https://travis-ci.org/dylanaraps/pywal.svg?branch=master)](https://travis-ci.org/dylanaraps/pywal)
`wal` is a script that takes an image (or a directory of images), generates a colorscheme (using `imagemagick`) and then changes all of your open terminal's colorschemes to the new colors on the fly. `wal` then caches each generated colorscheme so that cycling through wallpapers while changing colorschemes is instantaneous. `wal` finally merges the new colorscheme into the Xresources db so that any new terminal emulators you open use the new colorscheme.
`wal` can also change the colors in some other programs, check out the [WIKI](https://github.com/dylanaraps/pywal/wiki).
`wal` is a script that takes an image (or a directory of images), generates a colorscheme (using `imagemagick`) and then changes all of your open terminal's colors to the new colorscheme on the fly. `wal` then caches each generated colorscheme so that cycling through wallpapers while changing colorschemes is instantaneous.
`wal` also merges the new colorscheme into the Xresources database so that programs on your system such as `Rofi` or `i3` use the new colors automatically. `wal` finally exports the colors into various formats so that you can use the colors in webpages, scripts, other programs etc.
For more info, check out the [Wiki](https://github.com/dylanaraps/pywal/wiki).
**NOTE:** `wal` is not perfect and won't work well with some images.
**NOTE:** `wal` is not perfect and won't work with some images.
[Albums of examples (Warning large)](https://dylanaraps.com/pages/rice)