summaryrefslogtreecommitdiff
path: root/util/docker/doc.coreboot.org/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'util/docker/doc.coreboot.org/README.md')
-rw-r--r--util/docker/doc.coreboot.org/README.md33
1 files changed, 31 insertions, 2 deletions
diff --git a/util/docker/doc.coreboot.org/README.md b/util/docker/doc.coreboot.org/README.md
index 11c095d18e..d5d483eeba 100644
--- a/util/docker/doc.coreboot.org/README.md
+++ b/util/docker/doc.coreboot.org/README.md
@@ -1,3 +1,32 @@
-How to use:
+# doc.coreboot.org
+ Docker container for generating and developing documentation for doc.coreboot.org
-docker run --rm -v $path-to-coreboot.git:/data-in:ro -v $path-to-html-output:/data-out $image
+**NOTE**: All paths are from the base of the coreboot git repo.
+
+### Build
+
+```sh
+ docker build --force-rm -t "doc.coreboot.org" "$PWD/util/docker/doc.coreboot.org/"
+```
+
+### Generating production HTML
+
+```sh
+# To ensure the output directory is given the correct permissions, make sure to
+# created it before running docker the first time.
+mkdir -p "$PWD/Documentation/_build/"
+
+docker run -it --rm \
+ --user "$(id -u):$(id -g)" \
+ -v "$PWD/:/data-in/:ro" \
+ -v "$PWD/Documentation/_build/:/data-out/" \
+ doc.coreboot.org
+```
+
+### live reloaded with web server
+On the host machine, open a browser to the address http://0.0.0.0:8000
+```sh
+docker run -it --rm \
+ --net=host -v "$PWD/:/data-in/:ro" \
+ doc.coreboot.org livehtml
+```