Merge pull request #56 from dylanaraps/rd

misc: README changes and added code coverage.
This commit is contained in:
Dylan Araps 2017-07-23 20:07:03 +10:00 committed by GitHub
commit 640946562f
2 changed files with 7 additions and 17 deletions

View File

@ -7,9 +7,12 @@ before_install:
- sudo apt-get install -y imagemagick
install:
- pip install flake8 pylint
- pip install flake8 pylint codecov
script:
- flake8 pywal tests setup.py
- pylint pywal tests setup.py
- python setup.py test
- coverage run --source=pywal/ ./setup.py test
after_success:
- codecov

View File

@ -3,30 +3,17 @@
[![PyPI](https://img.shields.io/pypi/v/pywal.svg)](https://pypi.python.org/pypi/pywal/) [![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)
**\[[Installation](https://github.com/dylanaraps/pywal/wiki/Installation)\] \[[Getting Started](https://github.com/dylanaraps/pywal/wiki/Getting-Started)\] \[[Customization](https://github.com/dylanaraps/pywal/wiki/Customization)\] \[[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.
[Albums of examples (Warning large)](https://dylanaraps.com/pages/rice)
![screenshot](https://i.imgur.com/hkAJjJg.png)
## Installation
https://github.com/dylanaraps/pywal/wiki/Installation
## Getting Started
https://github.com/dylanaraps/pywal/wiki/Getting-Started
## Customization
https://github.com/dylanaraps/pywal/wiki