From d8569aa43e9eb6d5c9b4b498bdd00d6737c8d08a Mon Sep 17 00:00:00 2001
From: Emi Vasilek <emi.vasilek@gmail.com>
Date: Thu, 30 Nov 2023 03:04:13 +0000
Subject: [PATCH] Add README.md

---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..aa2dec4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# Comfy Recipes
+
+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
+Make sure you have hatchling and build modules installed.
+```sh
+python3 -m build
+```
+
+The package can now be installed with
+```sh
+pip install dist/comfy-recipes-*-py3-none-any.whl
+```
+
+## Building the docker container
+```sh
+docker build -t codeberg.org/comfy.city/comfy-recipes .
+```
+
+The container can now be ran
+```sh
+docker run --rm codeberg.org/comfy.city/comfy-recipes
+```
+
+## Building the documentation
+```sh
+cd docs
+mdbook build
+```
+
+Documentation can now be served with
+```sh
+mdbook serve
+```