Emi/comfy-recipes
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity

README.md: update

Browse source
This commit is contained in:
Emi Vasilek 2024-10-12 00:20:05 +02:00
parent 8a9ae16ad3
commit ae3ee28ab4
1 changed files with 10 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -4,7 +4,13 @@ Comfy Recipes is a simple application that renders your recipes into HTML.
Documentation is available at <https://comfy.city/comfy-recipes/docs>
## 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