From: Mathieu Baudier <redacted>
Date: Sun, 9 Feb 2025 17:52:18 +0000 (+0100)
Subject: Improve README
X-Git-Url: https://git.djapps.eu/?a=commitdiff_plain;h=50193bad20806ede9f0510c29aec8a21de240f75;p=pkg%2Fggml

Improve README
---

diff --git a/README.md b/README.md
index ecb8e1f..0a28154 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,27 @@
-A packaging harness for software of the ggml ecosystem.
+This packaging harness is based on git-buildpackage and simplifies the development of the packaging for software in the [ggml ecosystem](https://github.com/ggml-org).
 
+The software layers are configured as git submodules under the `sources/` subdirectory.
+ These git repositories follow Debian's [DEP-14](https://dep-team.pages.debian.net/deps/dep14/) layout
+ and can be used independently of this harness.
+
+# Quick start ####
 To use, clone recursively, for example:
 
 	git clone --recurse-submodules --branch unstable https://git.djapps.eu/pkg/ggml
 
-The software layers are configured as submodules under the `sources` directory.
+Make sure that you have the necessary packages installed:
+
+	sudo apt install git-buildpackage cowbuilder
+	
+Make sure you have a base for the distribution and arch that you are targeting:
 
-To build a layer, go to its directory and run:
+	sudo sh sources/create-pbuilder.sh <dist> <arch>
+	
+For example:
+
+	sudo sh sources/create-pbuilder.sh bookworm amd64
+
+To build a layer, cd to its directory and run:
 
 	sh ../build-pbuilder.sh <dist> <arch> [<branch>]
 
@@ -19,3 +34,8 @@ or:
 
 	cd sources/llama.cpp
 	sh ../build-pbuilder.sh bullseye amd64 debian/bullseye
+
+Except for `ggml` itself, pbuilder/cowbuilder needs to be configured appropriately
+ in order to use either a local repository with the `ggml` packages you just built,
+ or a remote repository with the required `ggml`-related packages.
+