DOCS: README

This commit is contained in:
Dylan Araps 2017-06-24 16:41:37 +10:00
parent 9b04dce308
commit 627e96aaf3

View File

@ -1,10 +1,10 @@
# pywal (A `wal` rewrite in Python 3)
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.md) [![Build Status](https://travis-ci.org/dylanaraps/wal.py.svg?branch=master)](https://travis-ci.org/dylanaraps/wal.py)
[![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/wal.py/wiki).
`wal` can also change the colors in some other programs, check out the [WIKI](https://github.com/dylanaraps/pywal/wiki).
**NOTE:** `wal` is not perfect and won't work with some images.
@ -135,4 +135,4 @@ optional arguments:
See the `wal` wiki!
**https://github.com/dylanaraps/wal.py/wiki**
**https://github.com/dylanaraps/pywal/wiki**