themer/cli/packages/wallpaper-block-wave/README.md

38 lines
1.8 KiB
Markdown
Raw Normal View History

2020-04-25 19:53:31 +00:00
# @themer/wallpaper-block-wave
2017-01-24 02:07:59 +00:00
2020-04-24 12:56:56 +00:00
A wallpaper template for [themer](https://github.com/mjswensen/themer). Here's a preview rendered using themer's default color set ([@themer/colors-default](https://github.com/mjswensen/themer/tree/master/cli/packages/colors-default)):
2020-04-15 12:44:01 +00:00
![desktop dark](https://cdn.jsdelivr.net/gh/mjswensen/themer@399430ac7b58691dc436761b1a03614898df92ba/cli/packages/themer-wallpaper-block-wave/assets/desktop-dark.svg)
![desktop light](https://cdn.jsdelivr.net/gh/mjswensen/themer@399430ac7b58691dc436761b1a03614898df92ba/cli/packages/themer-wallpaper-block-wave/assets/desktop-light.svg)
2016-11-27 06:44:14 +00:00
## Installation & usage
Install this module wherever you have `themer` installed:
2020-04-25 19:53:31 +00:00
npm install @themer/wallpaper-block-wave
2016-11-27 06:44:14 +00:00
2020-04-25 19:53:31 +00:00
Then pass `@themer/wallpaper-block-wave` as a `-t` (`--template`) arg to `themer`:
2016-11-27 06:44:14 +00:00
2020-04-25 19:53:31 +00:00
themer -c my-colors.js -t @themer/wallpaper-block-wave -o gen
2016-11-27 06:44:14 +00:00
2020-04-25 19:53:31 +00:00
`@themer/wallpaper-block-wave` will generate SVG wallpapers to the output directory (`gen/` in this example). (You can then convert them to a bitmap format, if necessary, [using Chrome](https://umaar.com/dev-tips/156-element-screenshot/) or other tools.)
2016-11-27 06:44:14 +00:00
2020-03-20 13:13:23 +00:00
The generated files will be listed in `<output dir>/README.md`.
2016-11-27 06:44:14 +00:00
### Default resolutions
2020-04-25 19:53:31 +00:00
By default, `@themer/wallpaper-block-wave` will output wallpapers at the following sizes:
2016-11-27 06:44:14 +00:00
* 2880 by 1800 (desktop)
* 750 by 1334 (device)
### Custom resolutions
2020-04-25 19:53:31 +00:00
`@themer/wallpaper-block-wave` adds the following argument to `themer`:
2016-11-27 06:44:14 +00:00
--themer-wallpaper-block-wave-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:
2020-04-25 19:53:31 +00:00
themer -c my-colors.js -t @themer/wallpaper-block-wave --themer-wallpaper-block-wave-size 1024x768 --themer-wallpaper-block-wave-size 320x960 -o gen