Say what the terms are, and how to install under them

The program had no licence file at all, and pyproject claimed MIT into
the void.  It is now the GNU General Public License, version 3 or later:
LICENSE holds the text verbatim, pyproject declares it with the OSI
classifier, both .deb builds write /usr/share/doc/<pkg>/copyright in the
machine-readable format Policy requires, both manuals carry a COPYING
section, and --version prints the GNU notice on both programs.

INSTALL.md is the step-by-step: what you need, the Debian package, the
virtual environment for everywhere else, how to check it worked, every
optional dependency with what it buys and what happens without it, and
the errors people actually hit first -- PEP 668 at the top, because on
Debian a plain "pip install ." refuses and reads as a broken program.

Speech transcription gets its own four steps, because it is the only
part with a real download in it: the recogniser into the environment
bandsaunter runs from, checking it took, the model (base.en, 148 MB,
from Hugging Face into ~/.cache/huggingface, fetched deliberately rather
than in the middle of a scan), then turning it on.  With the sizes of
every model, the offline routes, and what to do when --engines says no
although pip says yes.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016PsWPTweCT6pwxKngvVxcg
This commit is contained in:
The Dust Council 2026-09-03 22:58:18 -07:00
parent eae60cb04d
commit 4239635f74
14 changed files with 1390 additions and 11 deletions

View file

@ -19,8 +19,23 @@ mkdir -p "$site/bandsaunter" "$pkgdir/usr/bin" "$pkgdir/DEBIAN" \
"$pkgdir/usr/share/doc/bandsaunter"
cp "$here"/bandsaunter/*.py "$site/bandsaunter/"
cp "$here/README.md" "$pkgdir/usr/share/doc/bandsaunter/"
cp "$here/README.md" "$here/INSTALL.md" "$pkgdir/usr/share/doc/bandsaunter/"
gzip -9n "$pkgdir/usr/share/doc/bandsaunter/README.md"
gzip -9n "$pkgdir/usr/share/doc/bandsaunter/INSTALL.md"
# Debian Policy requires the licence verbatim, at this exact path, in every
# package. The header above it is the machine-readable format apt tools read.
{
echo "Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/"
echo "Upstream-Name: bandsaunter"
echo
echo "Files: *"
echo "Copyright: 2026 The Dust Council"
echo "License: GPL-3.0-or-later"
echo
echo "License: GPL-3.0-or-later"
sed 's/^$/./; s/^/ /' "$here/LICENSE"
} > "$pkgdir/usr/share/doc/bandsaunter/copyright"
# Regenerated from the settings table rather than copied, so the manual
# cannot describe a version of the settings that no longer exists.