themer/cli/packages/wallpaper-triangles/README.md

37 lines
1.4 KiB
Markdown
Raw Normal View History

2020-04-25 20:40:05 +00:00
# @themer/wallpaper-triangles
2017-08-13 01:58:34 +00:00
2020-04-24 12:56:56 +00:00
A wallpaper template for [themer](https://github.com/mjswensen/themer). Here's a preview using [themer's default color set](https://github.com/mjswensen/themer/tree/master/cli/packages/colors-default):
2017-08-13 01:58:34 +00:00
2020-04-15 12:44:01 +00:00
![dark desktop](https://cdn.jsdelivr.net/gh/mjswensen/themer@399430ac7b58691dc436761b1a03614898df92ba/cli/packages/themer-wallpaper-triangles/assets/desktop-dark.svg)
2017-08-13 01:58:34 +00:00
## Installation & usage
Install this module wherever you have `themer` installed:
2020-04-25 20:40:05 +00:00
npm install @themer/wallpaper-triangles
2017-08-13 01:58:34 +00:00
2020-04-25 20:40:05 +00:00
Then pass `@themer/wallpaper-triangles` as a `-t` (`--template`) arg to `themer`:
2017-08-13 01:58:34 +00:00
2020-04-25 20:40:05 +00:00
themer -c my-colors.js -t @themer/wallpaper-triangles -o gen
2017-08-13 01:58:34 +00:00
2020-04-25 20:40:05 +00:00
`@themer/wallpaper-triangles` will generate SVG wallpapers to the output directory (`gen/` in this example).
2017-08-13 01:58:34 +00:00
2020-03-20 13:13:23 +00:00
The generated files will be listed in `<output dir>/README.md`.
2017-08-13 01:58:34 +00:00
### Default resolutions
2020-04-25 20:40:05 +00:00
By default, `@themer/wallpaper-triangles` will output wallpapers at the following sizes:
2017-08-13 01:58:34 +00:00
* 2880 by 1800 (desktop)
* 750 by 1334 (device)
### Custom resolutions
2020-04-25 20:40:05 +00:00
`@themer/wallpaper-triangles` adds the following argument to `themer`:
2017-08-13 01:58:34 +00:00
--themer-wallpaper-triangles-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 20:40:05 +00:00
themer -c my-colors.js -t @themer/wallpaper-triangles --themer-wallpaper-triangles-size 1024x768 --themer-wallpaper-triangles-size 320x960 -o gen