Skip to content

Commit

Permalink
Add instructions for running with Docker
Browse files Browse the repository at this point in the history
  • Loading branch information
vslavik committed Jul 13, 2024
1 parent 1a4b8ba commit 99c8dde
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------------

Expand Down

0 comments on commit 99c8dde

Please sign in to comment.