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

@ -32,6 +32,9 @@ transcripts, identifications and playback, in one screen.
## Install
**[INSTALL.md](INSTALL.md) has the step-by-step version**, including the
optional dependencies and what goes wrong first. The short forms:
### From a package (Debian, Ubuntu, Mint)
```bash
@ -1848,3 +1851,14 @@ Receiving is not the same as being allowed to use or divulge what you hear. In
the US, the ECPA prohibits intercepting cellular and other private
communications, and rebroadcasting or acting on what you receive is separately
restricted. Check your local rules.
## Licence
Copyright © 2026 The Dust Council.
bandsaunter is free software: you can redistribute it and modify it under the
terms of the **GNU General Public License, version 3 or later**, as published
by the Free Software Foundation. It is distributed in the hope that it will be
useful, but with no warranty whatsoever — not even the implied warranty of
merchantability or fitness for a particular purpose. The full text is in
[LICENSE](LICENSE), and at <https://www.gnu.org/licenses/>.