Files
nowblinkie/readme.md
2026-05-15 17:20:10 +01:00

23 lines
703 B
Markdown

# nowblinkie
generate dynamic blinkies to use on your website,
using the output of arbitrary commands.
## usage
1. install requirements: `pip install -r requirements.txt`
2. run: `python main/src.py [-c config-file] [-L]`.
## docker
a [dockerfile](./dockerfile) and [compose file](./compose.yaml) have been provided.
keep in mind the commands will run in the docker container, too.
you do not need to clone this repository to use the compose file provided.
## config
the provided [example config file](./config.toml) lists all the options that can be used.
the blinkie templates and the font
([curie](https://github.com/oppiliappan/curie))
required to render them are included in the repository.