From 2307b5c56d319f770349843cfd26fa2c3bf053da Mon Sep 17 00:00:00 2001 From: Dakedres Date: Fri, 22 Mar 2024 09:31:43 -0600 Subject: [PATCH] Documentation cleanup, etc --- .gitignore | 1 + README.md | 48 ++--- build_documentation.sh => build_manual.sh | 0 doc/cookbook.md | 50 ++++- doc/doc.html | 212 ---------------------- doc/palette.png | Bin 0 -> 396 bytes 6 files changed, 75 insertions(+), 236 deletions(-) create mode 100644 .gitignore rename build_documentation.sh => build_manual.sh (100%) delete mode 100644 doc/doc.html create mode 100644 doc/palette.png diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e0af7f7 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +*/schemes/*.properties \ No newline at end of file diff --git a/README.md b/README.md index 01b660f..d3c7f44 100644 --- a/README.md +++ b/README.md @@ -7,45 +7,49 @@ It is less than 300 lines. It can go anywhere bash will, and will comfortably li your dotfiles. Compare with [tinty](https://github.com/tinted-theming/tinty). ## Installation -Clone the repo and add symlink it to somewhere in your PATH. Pick your poison +Clone the repo with submodules ``` +git clone --recurse-submodules https://git.sys42.net/dakedres/shchemes.git +``` +Add symlink it to somewhere in your PATH. Pick your poison +```sh ln -s $PWD/shchemes ~/bin/shchemes ln -s $PWD/shchemes ~/.local/bin/shchemes ``` -Install your favorite base16 themes from tinted-themes: -``` -shchemes install_tinted_scheme monokai -``` - -If you just want a bunch of themes to play with, try installing them all: -``` -shchemes install_all_tinted_schemes -``` - ## Usage -Shchemes can be used as a command or sourced to gain access to it's underlying functions. +Install your favorite base16 themes from tinted-themes: +```sh +shchemes install_tinted_scheme --scheme=monokai +``` +You can also exclude --scheme from any of these commands and it will read from your `SCHEME` environment variable. -In the terminal: +Append your theme to a config ```sh shchemes --scheme=base16:monokai create_theme kitty >> ~/.config/kitty/kitty.conf ``` + If you want to be able to hotswap themes, you'll probably need to use injection. ```sh -echo "#START SHCHEMES BLOCK : create_theme kitty" >> ~/.config/kitty/kitty.conf -shchemes --scheme=base16:monokai inject ~/.config/kitty/kitty.conf +echo "#START SHCHEMES BLOCK : shchemes create_theme kitty" >> ~/.config/kitty/kitty.conf # Add the comment for the injection block +shchemes --scheme=base16:monokai inject ~/.config/kitty/kitty.conf # Inject the theme ``` -In a script: +Here's an example script: ```bash -source shchemes --scheme=base16:monokai +export SCHEME="base16:horizon-terminal-dark" -inject "$HOME/.config/alacritty/alacritty.toml" -inject "$HOME/.config/rofi/config.rasi" +shchemes install_tinted_scheme + +shchemes inject "${HOME}/.config/kitty/kitty.conf" +shchemes inject "$HOME/.config/rofi/config.rasi" bspwm_theme="$HOME/.config/bspwm/colors" -create_theme bspwm > "$bspwm_theme" +shchemes create_theme bspwm > "$bspwm_theme" "$bspwm_theme" + +shchemes inject "${HOME}/.config/qutebrowser/config.py" +pkill -HUP qutebrowser # Reload qutebrowser config ``` Note you'll have to add all the comments for where to place the injections @@ -54,5 +58,5 @@ See the [cookbook](./doc/cookbook.md) for some ideas on ways to use Shchemes. ## Credits This software is a work of opportunism -- mo - Mustache templates in bash. Shchemes wouldn't be possible without it. -- tinted-theming/schemes - Pretty much all the base16 themes \ No newline at end of file +- [mo](https://github.com/tests-always-included/mo) - Mustache templates in bash. Shchemes wouldn't be possible without it. +- [tinted-theming/schemes](https://github.com/tinted-theming/schemes) - Pretty much all the base16 themes diff --git a/build_documentation.sh b/build_manual.sh similarity index 100% rename from build_documentation.sh rename to build_manual.sh diff --git a/doc/cookbook.md b/doc/cookbook.md index 5654326..d6e4dd0 100644 --- a/doc/cookbook.md +++ b/doc/cookbook.md @@ -1,5 +1,51 @@ # Cookbook -## ImageMagick +## Qutebrowser -### Apply a color scheme to an image +### Remotely reloading your Qutebrowser configuration +Qutebrowser can be remotely reloaded by sending it a SIGHUP signal. +```sh +pkill -HUP qutebrowser +``` +Note on older versions (<=3.1.0) this will simply kill Qutebrowser. + +## ImageMagick +Shchemes can create [ImageMagick pixel enumeration files](https://imagemagick.org/Usage/files/#txt), with a vertical strip of all the colors in the scheme. This is optimal for getting the color data into an image, or simply displaying the palette. + +### Displaying a palette at a reasonable size +This converts the pixel enumeration to a png and resizes it to 24px high with no interpolation. +```sh +shchemes create_theme imagemagick -s=base16:monokai | convert txt:- -filter point -resize 2400% palette.png +``` +Result: + +![A strip of all the colors in the monokai scheme](./palette.png) + +### Apply a color scheme to an image using [`-remap`](https://imagemagick.org/script/command-line-options.php#remap) +```sh +shchemes create_theme --scheme=base16:blueforest imagemagick | \ + | convert source.jpg -colorspace srgb -remap txt:- out.jpg +``` +Note that this is isn't like theming an app where your colors are simply slotted into the theme. It's trying to recreate your image the best it can with your color scheme. Images with a palette closer to your scheme will yield better results. + +A trick I've found for wallpapers is using an image twice your actual monitor resolution--This makes the dithering less visible while still somewhat retaining the color scheme change. + +### Apply a color scheme to an image with [`-dither`](https://www.imagemagick.org/Usage/quantize/#dither) +```sh +shchemes create_theme --scheme=base16:blueforest imagemagick | \ + | convert source.jpg -colorspace srgb -dither FloydSteinberg -remap txt:- out.jpg +``` +Another dithering model available is `Riemersma`, which gives a more splotchy, "boiled" look. + +## BSPWM + +### Generate a script to set bspwm colors +```sh +bspwm_theme="$HOME/.config/bspwm/colors" +shchemes create_theme bspwm > "$bspwm_theme" +"$bspwm_theme" +``` +You'll need to call it from your bspwmrc +```sh +"$(dirname $0)/colors" +``` diff --git a/doc/doc.html b/doc/doc.html deleted file mode 100644 index 87c02c0..0000000 --- a/doc/doc.html +++ /dev/null @@ -1,212 +0,0 @@ - - - - - - - manual - - - - -

NAME

-

shchemes - Automatically theming your apps with the power of the -shell.

-

SYNOPSIS

-
shchemes METHOD [OPTIONS]
-

DESCRIPTION

-

SCHEME

-

SCHEME is an environment variable that determines the default color -scheme to operate on.

-

Schemes are in a format of <scheme format>:<scheme -name>.

-

If no format is provided, base16 is assumed.

-

Examples

-
SCHEME="base16:heetch"
-
-SCHEME="base24:monokai"
-

See also: --scheme

-

OPTIONS

-

--scheme

-

Sets the color scheme to operate on, regardless of the value of -SCHEME.

-

Example

-
shchemes create_theme kitty --scheme=base16:blueforest
-

See also: SCHEME

-

--format

-

Sets the color scheme format of the output file. This defaults to the -same format as your color scheme.

-

Example

-
shchemes create_theme alacritty --format=base24
-

METHODS

-

create_theme

-

Apply the color scheme to the template for a given app

-
shchemes create_theme TARGET
-

See also: --format

-

inject

-

In the given file, looks for a comment that indicates a Shchemes -injection block, runs its command in a shell with Shchemes sourced, and -pipes the stdout into the content of the injection block.

-
shchemes inject PATH
-

install_tinted_scheme

-

Installs a color scheme from the tinted-theming/schemes.

-

You can find a gallery of the base16 themes here: https://tinted-theming.github.io/base16-gallery/

-
shchemes install_tinted_scheme
-

See also: SCHEME --scheme

-

AUTHOR

-

Shchemes is written by Dakedres

- - diff --git a/doc/palette.png b/doc/palette.png new file mode 100644 index 0000000000000000000000000000000000000000..03977b74f352b2e011ef0674aded8bad54fe50af GIT binary patch literal 396 zcmeAS@N?(olHy`uVBq!ia0y~yU~B-gB{-OY#j!obtRuCy?2 z>HO9oKR$i^^6}@7uRqm_{!W+wvcGiMBfW+1pQPPL(D{r(!) zv*X5@ipedSdk)D=+t5~iFwZt`|BqgyV)hf9t6-Y4{85o)98W`&u8HN}bSeY7F8Cq%s83qOmqh>RqXvob^ u$xN%nt>FT@@;;yj4Y&;@nYpROC5gEOxb?IPF(m@^FnGH9xvX