From 99c8dde9dc3143f12670ad6330dfb43f566d3161 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Va=CC=81clav=20Slavi=CC=81k?= <vaclav@slavik.io>
Date: Sat, 13 Jul 2024 12:56:16 +0200
Subject: [PATCH] Add instructions for running with Docker

---
 README | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README b/README
index 194626b0..bfa85818 100644
--- a/README
+++ b/README
@@ -7,6 +7,25 @@
 ============================================================================
 ============================================================================
 
+ Running with Docker or Podman
+-------------------------------
+
+As an alternative to installing Bakefile on your system, you can use Docker
+or Podman to run Bakefile in a container. The following command will run
+Bakefile in a container and mount the current directory as a volume:
+
+    docker run --rm -v $(pwd):/workdir -w /workdir ghcr.io/vslavik/bakefile:0.2 bakefile
+
+To run bakefile_gen, use the following command:
+
+    docker run --rm -v $(pwd):/workdir -w /workdir ghcr.io/vslavik/bakefile:0.2 bakefile_gen
+
+If your bakefiles depend on files in parent directories, you can mount a larger
+part of local filesystem, even your entire home directory, like this:
+
+    docker run --rm -v $HOME:$HOME -w $(pwd) ghcr.io/vslavik/bakefile:0.2 bakefile_gen
+
+
  Requirements
 --------------