From 01e214708017ca5b182bdda6578804172506d4a5 Mon Sep 17 00:00:00 2001
From: xengineering <mail2xengineering@protonmail.com>
Date: Thu, 10 Sep 2020 18:24:18 +0200
Subject: Write Documentation for Utils

---
 add_package.sh  | 6 +++---
 find_package.sh | 2 +-
 sign_package.sh | 2 +-
 3 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/add_package.sh b/add_package.sh
index 98150cb..8cad456 100755
--- a/add_package.sh
+++ b/add_package.sh
@@ -1,9 +1,9 @@
 #!/bin/bash
 
 
-REPO=$1
-ARCH=$2
-PKG=$3
+REPO=$1  # provide repository name (e.g. 'xengineering') as first argument
+ARCH=$2  # provide architecture (e.g. 'aarch64' or 'x86_64') as second argument
+PKG=$3   # provide path to package (e.g. 'xengineering-base-meta/xengineering-base-meta-1.0.0-1-any.pkg.tar.zst') as third argument
 
 PREFIX="repos/$REPO/os/$ARCH"
 DATABASE="$PREFIX/$REPO.db"
diff --git a/find_package.sh b/find_package.sh
index 0fe7410..153cfae 100755
--- a/find_package.sh
+++ b/find_package.sh
@@ -1,7 +1,7 @@
 #!/bin/bash
 
 
-PKG_NAME=$1
+PKG_NAME=$1  # provide the package name as argument
 
 
 find . -type f -iname "$PKG_NAME*.pkg.tar.zst" | grep -v "./repos*."
diff --git a/sign_package.sh b/sign_package.sh
index 7406f9b..185b0b5 100755
--- a/sign_package.sh
+++ b/sign_package.sh
@@ -1,7 +1,7 @@
 #!/bin/bash
 
 
-PKG=$1
+PKG=$1  # provide path to package (e.g. 'xengineering-base-meta/xengineering-base-meta-1.0.0-1-any.pkg.tar.zst') as argument
 
 
 gpg -u xengineering --detach-sign -o $PKG.sig $PKG
-- 
cgit v1.2.3-70-g09d2