History

Matt Swensen 685c3088ee Add previews to the readme		2020-05-29 14:08:05 -06:00
..
assets	Initial burst wallpaper implementation	2020-05-29 14:02:49 -06:00
lib	Initial burst wallpaper implementation	2020-05-29 14:02:49 -06:00
.gitignore	Initial burst wallpaper implementation	2020-05-29 14:02:49 -06:00
.yarnrc	Initial burst wallpaper implementation	2020-05-29 14:02:49 -06:00
package.json	Initial burst wallpaper implementation	2020-05-29 14:02:49 -06:00
README.md	Add previews to the readme	2020-05-29 14:08:05 -06:00

README.md

@themer/wallpaper-burst

A wallpaper template for themer.

Shown here with @themer/colors-solarized:

Installation & usage

Install this module wherever you have themer installed:

npm install @themer/wallpaper-burst

Then pass @themer/wallpaper-burst as a -t (--template) arg to themer:

themer -c my-colors.js -t @themer/wallpaper-burst -o gen

@themer/wallpaper-burst will generate SVG wallpapers to the output directory (gen/ in this example). (You can then convert them to a bitmap format, if necessary.)

Default resolutions

By default, @themer/wallpaper-burst will output wallpapers at the following sizes:

2880 by 1800 (desktop)
750 by 1334 (device)

Custom resolutions

@themer/wallpaper-burst adds the following argument to themer:

--themer-wallpaper-burst-size

to which you would pass <width>x<height>. For example, to forego the default resolutions and generate two wallpapers, one 1024 by 768 and one 320 by 960:

themer -c my-colors.js -t @themer/wallpaper-burst --themer-wallpaper-burst-size 1024x768 --themer-wallpaper-burst-size 320x960 -o gen