colorpickle/README.md

36 lines
1.1 KiB
Markdown
Raw Normal View History

2023-04-09 15:01:09 +00:00
# Colorpickle
![Screenshot of a colorscheme output in a terminal](https://i.imgur.com/06E4cWY.png)
A colorscheme generator.
## Building
Clone this repository, then run:
```sh
cargo build --release
```
The output binary will be in `target/release/colorpickle`
Alternatively,
```sh
nix build github:AgathaSorceress/colorpickle
```
A binary for linux-x86_64 is built on [each commit](https://github.com/AgathaSorceress/colorpickle/actions) and uploaded to Artifacts.
## Usage
```
Usage: colorpickle [OPTIONS] <IMAGE>
Arguments:
<IMAGE> Path to image to pick colors from
Options:
2023-04-09 16:43:40 +00:00
-c, --colors <COLORS> Number of colors to generate (excluding bold colors) [default: 8]
-b, --no-bold Skip generating bold color variants
--bold-delta <BOLD_DELTA> How much lightness should be added to bold colors [default: 0.2]
--rotate-hue <ROTATE_HUE> Rotate colors along the hue axis [default: 0]
--lighten <LIGHTEN> Lighten/darken colors [default: 0]
--saturate <SATURATE> Saturate/desaturate colors [default: 0]
-h, --help Print help
-V, --version Print version
2023-04-09 15:01:09 +00:00
```