From 1cb257c485065bffda5d5abb6968cb6b91a5a339 Mon Sep 17 00:00:00 2001
From: Manuel Friedli <manuel@fritteli.ch>
Date: Sun, 23 Jun 2024 00:57:30 +0200
Subject: [PATCH] Add readme and rename Dockerfile.

---
 pkgcheck.Dockerfile => Dockerfile |  0
 readme.md                         | 24 ++++++++++++++++++++++++
 2 files changed, 24 insertions(+)
 rename pkgcheck.Dockerfile => Dockerfile (100%)
 create mode 100644 readme.md

diff --git a/pkgcheck.Dockerfile b/Dockerfile
similarity index 100%
rename from pkgcheck.Dockerfile
rename to Dockerfile
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..5e84fd0
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,24 @@
+# Build instructions
+
+Run `docker build .` in this directory. After the build succeeds, note the image hash.
+
+
+# Troubleshooting
+
+If you get any error during the build, try pulling the required base images prior to building:
+```commandline
+docker image pull gentoo/portage:latest
+docker image pull gentoo/stage3:amd64-nomultilib-openrc
+```
+
+# Publishing
+Tag the build image with the current date as the name:
+```commandline
+docker image tag <hash> fritteli/pkgcheck:yyyyMMdd
+docker image tag <hash> fritteli/pkgcheck:latest
+```
+Push the tagged images:
+```commandline
+docker image push fritteli/pkgcheck:yyyyMMdd
+docker image push fritteli/pkgcheck:latest
+```