From 0354046e3c0aa9a1cfb47162dd2bee4fd968863c Mon Sep 17 00:00:00 2001 From: Ruakij Date: Wed, 23 Nov 2022 19:09:11 +0100 Subject: [PATCH] Add Instructions on how to use project --- README.md | 34 ++++++++++++++++++++++++++++++++-- 1 file changed, 32 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d6d6370..b6f1b8f 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,41 @@ Collection of Dockerfiles created to build & pack various tools.
-- [1. Tools](#1-tools) +- [1. How to use](#1-how-to-use) + - [1.1. CLI](#11-cli) +- [2. Tools](#2-tools)
-# 1. Tools +# 1. How to use + +Run the build-script `script/build.sh` with the path to the tool you want to build. + +
+ +The docker-image will be tagged with `default` and the detected version/commit-hash. + +You can add more tags or change the existing tag-naming-scheme using the environment-variable `TAG`. + +
+ +## 1.1. CLI + +`script/build.sh [extra-args for docker build ..]` + +
+ +### 1.1.1. Environment-Variables + +Variable | Description | Default +-|-|- +`TAG` | Tag for Docker-building | `TAGPREFIX` + `NAME` +`TAGPREFIX` | Set a prefix to the default-tag | - +`NAME` | Change the name used in the tag | *FolderName* + +
+ +# 2. Tools Nothing yet