From: Mathieu Baudier <redacted>
Date: Sat, 15 Feb 2025 06:44:48 +0000 (+0100)
Subject: Improve README
X-Git-Url: https://git.djapps.eu/?a=commitdiff_plain;h=322e9ffdede68d8de4f1b444e581a4e73657c849;p=pkg%2Fggml

Improve README
---

diff --git a/README.md b/README.md
index cba01ad..1747b89 100644
--- a/README.md
+++ b/README.md
@@ -64,3 +64,37 @@ A shortcut is provided (which requires the dependent packages to be installed lo
 
 	cd sources/whisper.cpp
 	../build.dev
+
+### Update upstream
+(Using `ggml` as an example, the same approach applies to the other layers)
+
+In a given layer git repository, make sure the upstream git repository is registered as remote:
+
+	cd sources/ggmll
+	git remote add github https://github.com/ggml-org/ggml.git
+
+Fetch new commits from upstreams's `main` branch, and merge them to the `upstream/latest` branch.
+
+	git fetch github main
+	git checkout upstream/latest
+	git merge --ff-only github/master
+
+Check out the commit you are interested in and count revisions in order to create a versioned tag:
+
+	git checkout 9a4acb374565f4146b8d6eb1cffdcd7d437d1ba2
+	# ggml or llama.cpp
+	git tag upstream/0.0.$(git rev-list --count HEAD)
+	# whisper.cpp
+	# git tag upstream/1.7.4+$(git rev-list --count v1.7.4..HEAD)
+
+### New package release
+After updating upstream, checkout `debian/latest` and merge from upstream tag:
+
+	git checkout debian/latest
+	git merge upstream/0.0.1722
+
+Edit `debian/changelog` and perform packaging-specific changes.
+
+Test the build locally:
+
+	../build-pbuilder bookworm amd64