From a7bed2ebde1bf4687103123c5c6af5e839554236 Mon Sep 17 00:00:00 2001 From: rameskum Date: Mon, 30 Sep 2024 18:56:25 -0400 Subject: [PATCH] feat(README): Enhance README with Docker instructions docs(Dockerfile): Add Dockerfile for containerized execution of MKBSD --- Dockerfile | 10 ++++++++++ README.md | 10 ++++++++-- 2 files changed, 18 insertions(+), 2 deletions(-) create mode 100644 Dockerfile diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..9f83bde --- /dev/null +++ b/Dockerfile @@ -0,0 +1,10 @@ +FROM --platform=${BUILDPLATFORM} python:3.9.20-slim-bookworm + +RUN pip install aiohttp +VOLUME /app/downloads + +WORKDIR /app +COPY mkbsd.py . + +CMD ["python", "mkbsd.py"] + diff --git a/README.md b/README.md index 2d34182..5fddf08 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ ``` - /$$ /$$ /$$ /$$ /$$$$$$$ /$$$$$$ /$$$$$$$ + /$$ /$$ /$$ /$$ /$$$$$$$ /$$$$$$ /$$$$$$$ | $$$ /$$$| $$ /$$/| $$__ $$ /$$__ $$| $$__ $$ | $$$$ /$$$$| $$ /$$/ | $$ \ $$| $$ \__/| $$ \ $$ | $$ $$/$$ $$| $$$$$/ | $$$$$$$ | $$$$$$ | $$ | $$ | $$ $$$| $$| $$ $$ | $$__ $$ \____ $$| $$ | $$ | $$\ $ | $$| $$\ $$ | $$ \ $$ /$$ \ $$| $$ | $$ | $$ \/ | $$| $$ \ $$| $$$$$$$/| $$$$$$/| $$$$$$$/ -|__/ |__/|__/ \__/|_______/ \______/ |_______/ +|__/ |__/|__/ \__/|_______/ \______/ |_______/ ``` _Because selling out is bad_ @@ -30,6 +30,12 @@ MKBSD comes in two variants! Node.js and Python. 4. Wait a little. 5. All wallpapers are now in a newly created `downloads` subfolder. +### Running using docker + +1. Ensure you have docker installed +2. Build the image with `docker build -t mkbsd .` +3. Run the image, mounting a directory where you want the image to be stored as a volume at `/app/downloads`. For example, `docker run -v $PWD:/app/downloads mkbsd` + ## FAQ ### Q: What's the story behind this?