diff --git a/README.md b/README.md index 32f9eba..2e85b1b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,105 @@ -# butt-packaging +# Butt DEB Packaging -Unofficial Ubuntu build of Butt (upstream source, dynamically linked, no AAC) \ No newline at end of file +This repository contains the transparent, reproducible build script used to compile the official Butt (Broadcast Using This Tool) source code (`.tar.xz` / `.tar.gz`) into a single `.deb` package for Ubuntu. + +**This is an unofficial build.** I compile the upstream source code without modifying it. + +## Key Features of This Build + +- **Dynamic linking:** Built natively against the system's FLAC and PortMIDI libraries for better compatibility and a smaller size. +- **No AAC support:** The `fdk-aac` library is intentionally excluded due to licensing restrictions. +- **Custom icons:** Includes high-quality icons and a desktop entry provided by New Life Linux. + +## How It Works + +The `build-butt-dynamic.sh` script: + +1. Downloads the latest official Butt source code. +2. Bootstraps the build environment. **Docker is strongly recommended and is used by default if you are not on the exact target OS.** +3. Compiles the software with dynamic linking. +4. Verifies that the compiled binary does **not** link to the `fdk-aac` library. +5. Generates **separate** checksum files: `upstream_sha256_X.txt` (for the source code) and `SHA256SUMS_X.deb` (for the resulting `.deb`). + +## How to Verify (Reproducible Builds via Docker) + +You don't have to trust me; you can build and verify the package yourself! The **Docker method is the most reliable way** to ensure you are using the exact same environment as I did. + +1. Download the build script from this repository. +2. Run the explicit Docker command for Ubuntu 22.04. This guarantees an isolated environment with the exact dependencies needed for the target OS: + + ```bash + docker run --rm -it -v "$PWD":/work -w /work ubuntu:22.04 bash ./build-butt-dynamic.sh 22.04 + ``` + + > **Note:** If you simply run `./build-butt-dynamic.sh 22.04` on your host machine, the script will automatically execute the Docker command above for you, unless you are already on Ubuntu 22.04. + +3. Compare the SHA256 checksum of the `.deb` you just built with the one provided on the [Releases](../../releases) page. If they match, you have verified that the package is authentic. + +## Security & GPG Public Key + +To ensure the integrity of the packages, I provide my public GPG key. + +- **Download:** [`butt-key.asc`](butt-key.asc) +- **Key fingerprint:** `58C2 7061 659D E241 945C 46D9 09F8 C5A9 DD99 F24C` + +Import it with: + +```bash +gpg --import butt-key.asc +``` + +**Maintained by:** New Life Linux (Gre Weaver) – [greweaver@newlifelinux.org](mailto:greweaver@newlifelinux.org) + +--- + +# Butt DEB csomagolás (magyar) + +Ez a tároló tartalmazza azt az átlátható, reprodukálható build scriptet, amely a hivatalos Butt (Broadcast Using This Tool) forráskódból (`.tar.xz` / `.tar.gz`) egyetlen `.deb` csomagot fordít Ubuntu rendszerekre. + +**Ez egy nem hivatalos build.** A hivatalos forráskódot módosítás nélkül fordítom le. + +## A build főbb jellemzői + +- **Dinamikus linkelés:** Natívan a rendszer FLAC és PortMIDI könyvtáraihoz linkel a jobb kompatibilitás és a kisebb méret érdekében. +- **Nincs AAC-támogatás:** Az `fdk-aac` könyvtár licencelési korlátozások miatt szándékosan ki van zárva. +- **Egyedi ikonok:** Tartalmazza a New Life Linux által készített kiváló minőségű ikonokat és az asztali indítóbejegyzést. + +## Hogyan működik? + +A `build-butt-dynamic.sh` script a következőket teszi: + +1. Letölti a legfrissebb hivatalos Butt forráskódot. +2. Előkészíti a build környezetet. **A Docker használata erősen ajánlott, és alapértelmezetten akkor is ezt használja a script, ha nem a pontos célrendszeren futtatod.** +3. Dinamikus linkeléssel lefordítja a szoftvert. +4. Ellenőrzi, hogy a lefordított bináris **nem** linkel az `fdk-aac` könyvtárhoz. +5. **Külön** ellenőrzőösszeg-fájlokat generál: `upstream_sha256_X.txt` (a forráskódhoz) és `SHA256SUMS_X.deb` (a létrejött `.deb` csomaghoz). + +## Hogyan ellenőrizheted? (Reprodukálható buildek Dockerrel) + +Nem kell feltétlenül megbíznod bennem; magad is lefordíthatod és ellenőrizheted a csomagot! A Docker a legmegbízhatóbb módszer, mert garantálja, hogy pontosan ugyanazt a környezetet használod, mint én. + +1. Töltsd le a build scriptet ebből a tárolóból. +2. Futtasd le az alábbi, Ubuntu 22.04-re vonatkozó Docker-parancsot. Ez egy izolált környezetet biztosít a célrendszerhez szükséges pontos függőségekkel: + + ```bash + docker run --rm -it -v "$PWD":/work -w /work ubuntu:22.04 bash ./build-butt-dynamic.sh 22.04 + ``` + + > **Megjegyzés:** Ha egyszerűen csak lefuttatod a `./build-butt-dynamic.sh 22.04` parancsot a saját gépeden, a script automatikusan végrehajtja a fenti Docker-parancsot, kivéve, ha már Ubuntu 22.04-en vagy. + +3. Hasonlítsd össze az általad épített `.deb` fájl SHA256 ellenőrzőösszegét a [Kiadások (Releases)](../../releases) oldalon megadottal. Ha megegyeznek, igazoltad, hogy a csomag hiteles. + +## Biztonság és GPG nyilvános kulcs + +A csomagok integritásának biztosítása érdekében közzéteszem a nyilvános GPG-kulcsomat. + +- **Letöltés:** [`butt-key.asc`](butt-key.asc) +- **Kulcs ujjlenyomata (fingerprint):** `58C2 7061 659D E241 945C 46D9 09F8 C5A9 DD99 F24C` + +Importálás: + +```bash +gpg --import butt-key.asc +``` + +**Karbantartja:** New Life Linux (Gre Weaver) – [greweaver@newlifelinux.org](mailto:greweaver@newlifelinux.org) \ No newline at end of file