From f666a3abc6b43f082a13aab35825256464553490 Mon Sep 17 00:00:00 2001
From: langfingaz <daniel@systemli.org>
Date: Fri, 14 May 2021 14:50:43 +0200
Subject: [PATCH] update README

---
 README.md                      | 38 ++++++++++++++++++++++++++++++++--
 pkg/de-p1st-repo/PKGBUILD      |  2 +-
 pkg/de-p1st-repo/arch-repo.cfg | 12 +++++++----
 3 files changed, 45 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index aab8f61..e959f03 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,40 @@
 # My personalized Arch Linux packages
 
-## Some notes
+## Build packages from source
+
+Fork this repository.
+
+Then and adjust the following files:
+* [pkg/de-p1st-repo/arch-repo.cfg](pkg/de-p1st-repo/arch-repo.cfg)
+  * For your build-machine, adjust section `LOCAL MACHINE CONFIGURATION`: Add absolute path of folder [./out](./out) to array `LOCAL_PKG_DIRS`
+    as the build packages will be stored there.
+  * For your mirror-server, adjust section `REMOTE MIRROR SERVER CONFIGURATION` accordingly.
+* [pkg/de-p1st-pacman/pacman.d/de-p1st](pkg/de-p1st-pacman/pacman.d/de-p1st)
+  * Add the address of your mirror-server.
+
+Build [de-p1st-repo](pkg/de-p1st-repo) ...
+
+```shell
+sudo docker-compose run makepkg de-p1st-repo
+```
+
+... and install it on your build-machine and your mirror-server:
+
+```shell
+# on your local machine
+sudo pacman -U out/de-p1st-repo*.pkg.tar.*
+
+# copy the package to your mirror-server and install it there as well
+```
+
+Then you can start building all packages and adding them to your mirror-server:
+
+```shell
+./build-pkg-docker.sh
+```
+
+
+## Some notes on arch (meta-)package management
 
 * https://disconnected.systems/blog/archlinux-meta-packages/
 * https://nerdstuff.org/posts/2020/2020-002_meta_packages/
@@ -90,4 +124,4 @@ Enter a number (default=1):
 ```
 
 **TODO**: How does Pacman pick the default option? Are packages simply
-ordered alphabetically?
\ No newline at end of file
+ordered alphabetically?
diff --git a/pkg/de-p1st-repo/PKGBUILD b/pkg/de-p1st-repo/PKGBUILD
index 1fbf5c7..3c68c10 100644
--- a/pkg/de-p1st-repo/PKGBUILD
+++ b/pkg/de-p1st-repo/PKGBUILD
@@ -2,7 +2,7 @@
 _pkgname=repo
 _reponame=arch
 pkgname="de-p1st-$_pkgname"
-pkgver=0.2.2
+pkgver=0.2.3
 pkgrel=1
 pkgdesc="Bash script to manage remote Arch Linux repository"
 arch=('any')
diff --git a/pkg/de-p1st-repo/arch-repo.cfg b/pkg/de-p1st-repo/arch-repo.cfg
index ff67bdb..24b4bd1 100644
--- a/pkg/de-p1st-repo/arch-repo.cfg
+++ b/pkg/de-p1st-repo/arch-repo.cfg
@@ -1,9 +1,13 @@
-# Host from ssh configuration which logs in
-# as correct user to have write access to
-# REMOTE_PKG_DIR.
-REMOTE_SSH_HOST=rootnas
+#=== LOCAL MACHINE CONFIGURATION ===#
 
+# Locations of built packages
 LOCAL_PKG_DIRS=('/home/custompkgs' '/home/yoda/Downloads/git/arch/out')
+
+#=== REMOTE MIRROR SERVER CONFIGURATION ===#
+
+# Host from ssh configuration with correct user to have
+# write access to REMOTE_PKG_DIR and REMOTE_DB_NAME
+REMOTE_SSH_HOST=rootnas
 REMOTE_PKG_DIR=/mnt/data/live/arch-repo
 REMOTE_DB_NAME=de-p1st