Skip to content

docs(build): note optional setup-deepfilter.sh prereq for local DFNR #4282

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ten9876 merged 2 commits into from
Jul 19, 2026
Merged

docs(build): note optional setup-deepfilter.sh prereq for local DFNR #4282

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
16a715c
docs(build): note optional setup-deepfilter.sh prereq for local DFNR
ten9876 Jul 17, 2026
6d71d48
docs(build): tighten DFNR note — release-build precision, RN2 fallback
ten9876 Jul 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,16 @@ cmake --build build -j$(nproc)
./build/AetherSDR
```

**Optional — DFNR (DeepFilterNet3) noise reduction.** Run
`scripts/setup/setup-deepfilter.sh` (Windows: `setup-deepfilter.ps1`)
*once before* `cmake` to fetch the prebuilt `libdeepfilter` for your
platform; configure will otherwise report `DFNR ... disabled — library
not found` and gate the feature off. CI runs this step automatically
(cached) in the release-build workflows, so shipped binaries always
include DFNR; it is a manual prereq only for local dev builds. NR still
works without it — RN2 (RNNoise) is bundled and always built, needing no
setup.

Full dependency list is in `README.md` — don't duplicate it here.

Current version: **26.7.2** (set in both `CMakeLists.txt` and `README.md`).
Expand Down
Loading