diff --git a/README.md b/README.md index 3e886c8..15c3e4b 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,13 @@ Comfy Recipes is a simple application that renders your recipes into HTML. Documentation is available at -## Building the python package +## Running +```sh +docker run -v ./recipes:/recipes git.comfy.city/Emi/comfy-recipes:latest build /recipes +``` + +## Building +### Building the python package Make sure you have hatchling and build modules installed. ```sh python3 -m build @@ -15,17 +21,17 @@ The package can now be installed with pip install dist/comfy-recipes-*-py3-none-any.whl ``` -## Building the docker container +### Building the docker container ```sh docker buildx build -t git.comfy.city/Emi/comfy-recipes:local . ``` The container can now be ran ```sh -docker run --rm git.comfy.city/Emi/comfy-recipes:local +docker run -v ./recipes:/recipes git.comfy.city/Emi/comfy-recipes:local build /recipes ``` -## Building the documentation +### Building the documentation ```sh cd docs mdbook build