luna/catacomb
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: rename yt-offline → Catacomb across README, ROADMAP, guides, packaging

Browse source 
Prose + commands updated to the new name: brand reads "Catacomb", while
binary/path/package references are the lowercase `catacomb` (commands, deb/rpm
names, ~/.local/share/catacomb, catacomb.db, catacomb.desktop). Codeberg repo
URLs left pointing at the existing repo. Also folds in the pending doc edits
from earlier in the session.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
Luna 2026-06-19 03:34:18 -07:00
parent 404362bfb0
commit 3f611849af
72 changed files with 1513 additions and 293 deletions
Download patch file Download diff file Expand all files Collapse all files

34
docs/src/installation.md
View file

@ -1,6 +1,6 @@
# Installation
yt-offline is a single Rust binary. You can install a prebuilt package,
Catacomb is a single Rust binary. You can install a prebuilt package,
build from source, or grab the AppImage.
## Runtime dependencies
@ -8,7 +8,7 @@ build from source, or grab the AppImage.
Whichever way you install, these are invoked as subprocesses at runtime:
- **yt-dlp** — the download engine. You can use the system one *or* let
yt-offline manage a bundled copy (see [First run](./first-run.md)).
catacomb manage a bundled copy (see [First run](./first-run.md)).
- **ffmpeg** — muxing, format conversion, on-the-fly transcode for the
web player.
- **mpv** — the default desktop player (any player taking a file path
@ -21,14 +21,14 @@ Releases attach `.deb`, `.rpm`, and `.AppImage` artifacts.
```sh
# Debian / Ubuntu / Mint
sudo apt install ./yt-offline_*_amd64.deb
sudo apt install ./catacomb_*_amd64.deb
# Fedora / RHEL / openSUSE (ffmpeg via RPM Fusion)
sudo dnf install ./yt-offline-*.x86_64.rpm
sudo dnf install ./catacomb-*.x86_64.rpm
# Any Linux — AppImage
chmod +x yt-offline-*-x86_64.AppImage
./yt-offline-*-x86_64.AppImage
chmod +x catacomb-*-x86_64.AppImage
./catacomb-*-x86_64.AppImage
```
## Arch / CachyOS / Manjaro
@ -55,11 +55,11 @@ sudo apt install build-essential pkg-config curl git python3-venv \
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source "$HOME/.cargo/env"
git clone https://codeberg.org/anassaeneroi/yt-offline
cd yt-offline
git clone https://codeberg.org/anassaeneroi/catacomb
cd catacomb
cargo build --release
./target/release/yt-offline # desktop GUI
./target/release/yt-offline --web 8080 # headless web server
./target/release/catacomb # desktop GUI
./target/release/catacomb --web 8080 # headless web server
```
`python3-venv` is only needed for the bundled-yt-dlp install path; skip
@ -67,7 +67,13 @@ it if you'll always use system yt-dlp.
## Windows / macOS
Not first-class yet. The Linux-only system tray (`ksni`) and file dialog
(`rfd` xdg-portal) need per-OS backends before a clean cross-build; the
rest of the stack already compiles. See the
[architecture notes](./architecture.md#platform-support).
Windows is available as a release zip when built through
`scripts/package.sh win` or tag-release CI. It includes `catacomb.exe`,
the license, and a short runtime-dependency README; install `yt-dlp`,
`ffmpeg`, and `mpv` / `mpv.net` on PATH.
macOS has a local osxcross packaging path (`scripts/package.sh mac`) that
assembles an unsigned `.app` zip when you provide an Apple SDK locally.
It is not built in public CI because the SDK cannot be redistributed, and
codesigning/notarization remain follow-ups. See
[packaging](./packaging.md) and the [architecture notes](./architecture.md#platform-support).