From 9ddf1c97580147130ef8d4c2c495684506e70375 Mon Sep 17 00:00:00 2001 From: Dylan Araps Date: Fri, 30 Jun 2017 18:41:37 +1000 Subject: [PATCH] docs: README --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0f1bf38..44bd935 100644 --- a/README.md +++ b/README.md @@ -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)