From a3f17c666329d600cad825db70ca7e68c7ef48a0 Mon Sep 17 00:00:00 2001
From: Jannik C <12862103+masseelch@users.noreply.github.com>
Date: Thu, 11 Feb 2021 12:45:18 +0100
Subject: [PATCH] Update config

Adds a comment how to set `BASE_ZIP_IMG` to a custom value.
---
 src/modules/base/config | 1 +
 1 file changed, 1 insertion(+)

diff --git a/src/modules/base/config b/src/modules/base/config
index 9ea43c79..456018d6 100644
--- a/src/modules/base/config
+++ b/src/modules/base/config
@@ -15,6 +15,7 @@ BASE_VERSION=1.5.0
 # Distro
 [ -n "$BASE_DISTRO" ] || BASE_DISTRO=raspbian
 
+# Note: Set BASE_ZIP_IMG relative to the distro/src/workspace directory to pass a custom named file or an already extracted '.img'-file.
 if [ "${BASE_DISTRO}" == "ubuntu" ]; then
   # Default image ubuntu
   [ -n "$BASE_ZIP_IMG" ] || BASE_ZIP_IMG=`ls -t $BASE_IMAGE_PATH/ubuntu-*.xz | head -n 1`