diff options
| author | eug-vs <eugene@eug-vs.xyz> | 2021-08-14 01:46:52 +0300 |
|---|---|---|
| committer | eug-vs <eugene@eug-vs.xyz> | 2021-08-14 01:46:52 +0300 |
| commit | 53b16af3ef5f4d62e8b2319f2e2c60923e04f063 (patch) | |
| tree | a402dedb6f6e46a172f82285ea3d91abebb76a1d | |
| parent | 0e389c59bb061f8eb32b102e7073ff0eb1d934ee (diff) | |
| download | telegram-based-wojak-53b16af3ef5f4d62e8b2319f2e2c60923e04f063.tar.gz | |
docs: add README
| -rw-r--r-- | README.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..5bb30f3 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# telegram-based-wojak +Source images and convert script for **based wojak** stickerpack. + +# Usage +## Prerequisites + - [make](https://www.gnu.org/software/make/) + - [imagemagick](https://imagemagick.org) - used to convert source images into stickers + - [sxiv](https://github.com/muennich/sxiv) - optional, can be used to gallery-preview stickerpack + +## Generating stickerpack +In order to generate telegram-adapted stickers from the images in `src` directory, simply run: +```bash +$ make +``` +Generated stickers are located in `out` directory, you can preview them with `sxiv`: +``` +$ make view +``` + +# TODO + - Automatically publish new stickers using `CircleCI` + +# Contributing +Feel free to submit a *Pull Request* and add more stickers! + |