started on readme wip/documentation
authorRalph Ronnquist <rrq@rrq.au>
Fri, 28 Nov 2025 14:42:01 +0000 (01:42 +1100)
committerRalph Ronnquist <rrq@rrq.au>
Fri, 28 Nov 2025 14:42:01 +0000 (01:42 +1100)
README.adoc [new file with mode: 0644]

diff --git a/README.adoc b/README.adoc
new file mode 100644 (file)
index 0000000..6da0c11
--- /dev/null
@@ -0,0 +1,17 @@
+= timeliner project
+
+== building debian package
+
+The upstream software is held as the "master" branch of the project
+while the "debian" branch is used for debian package building.
+
+The debian branch is therfore a (successive) merge of tha master
+branch at tagged "release" versions together with the debian tree that
+is maintained in that branch (only). The building of debian packages
+are done with "gbp buildpackage", which then uses the current
+debian/changelog file to work out which upstream software version is
+concerned and debian/gbp.conf to connect that with the git tag for the
+relevant master branch commit. That commit needs to be merged into the
+debian branch and committed in addition to any packaging set up
+specific for debian package building, e.g. the updated of
+debian/changelog.