Adding a README and previews.
This commit is contained in:
parent
a280f9d97a
commit
aba439018f
39
README.md
Normal file
39
README.md
Normal file
@ -0,0 +1,39 @@
|
||||
A wallpaper template for mjswensen/themer.
|
||||
|
||||
## Installation & usage
|
||||
|
||||
Install this module wherever you have `themer` installed:
|
||||
|
||||
yarn add themer-wallpaper-octagon
|
||||
|
||||
Then pass `themer-vim` as a `-t` (`--template`) arg to `themer`:
|
||||
|
||||
themer -c my-colors.js -t themer-wallpaper-octagon -o gen
|
||||
|
||||
`themer-wallpaper-octagon` will generate SVG and PNG wallpapers to the output directory (`gen/` in this example).
|
||||
|
||||
### Default resolutions
|
||||
|
||||
By default, `themer-wallpaper-octagon` will output wallpapers at the following sizes:
|
||||
|
||||
* 2880 by 1800 (desktop)
|
||||
* 750 by 1334 (device)
|
||||
|
||||
### Custom resolutions
|
||||
|
||||
`themer-wallpaper-octagon` adds the following argument to `themer`:
|
||||
|
||||
--themer-wallpaper-octagon-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-octagon --themer-wallpaper-octagon-size 1024x768 --themer-wallpaper-octagon-size 320x960 -o gen
|
||||
|
||||
## Previews
|
||||
|
||||
The following are rendered using themer's default color set (mjswensen/themer-colors-default):
|
||||
|
||||
![dark desktop](/assets/desktop-dark.png)
|
||||
![light desktop](/assets/desktop-light.png)
|
||||
![dark device](/assets/device-dark.png)
|
||||
![light device](/assets/device-light.png)
|
BIN
assets/desktop-dark.png
Normal file
BIN
assets/desktop-dark.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 2.4 MiB |
BIN
assets/desktop-light.png
Normal file
BIN
assets/desktop-light.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 2.1 MiB |
BIN
assets/device-dark.png
Normal file
BIN
assets/device-dark.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 348 KiB |
BIN
assets/device-light.png
Normal file
BIN
assets/device-light.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 294 KiB |
Loading…
Reference in New Issue
Block a user