Repository navigation
docs: installation-first README with all package channels - #545
Conversation
- Move Installation above the device table and lead with package managers - Add the new channels: apt (PPA), dnf (COPR, + EPEL note for RHEL family), Homebrew stable (drop --HEAD default), AUR, FreeBSD, and release binaries (AppImage/.deb/.rpm/installer) - Collapse build-from-source into a <details> block; refresh compiler reqs
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: f55273cfd2
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| **Ubuntu / Debian** — [PPA](https://launchpad.net/~sapd/+archive/ubuntu/headsetcontrol) | ||
| ```bash | ||
| sudo add-apt-repository ppa:sapd/headsetcontrol | ||
| sudo apt update && sudo apt install headsetcontrol |
There was a problem hiding this comment.
On Debian, this PPA command adds an Ubuntu repository using the Debian codename, for which the PPA does not publish a Release file; apt update therefore fails and the advertised Debian installation path cannot install the package. Label this path as Ubuntu-only or provide a Debian-compatible package source.
Useful? React with 👍 / 👎.
| `hidapi` ships in EPEL on the RHEL family, so enable that first: | ||
| ```bash | ||
| brew install sapd/headsetcontrol/headsetcontrol --HEAD | ||
| sudo dnf install epel-release |
There was a problem hiding this comment.
On a stock RHEL-family 10 system, epel-release is not available until EPEL has been enabled, so this first command fails and the subsequent COPR installation cannot run. Use the appropriate EPEL release RPM/bootstrap instructions (and required CRB repository) for the listed RHEL distributions.
Useful? React with 👍 / 👎.
1 participant
Restructures the README so Installation is front and center (right after Features, above the device table) and leads with package managers.
--HEADby default), AUR, FreeBSD, and the signed release binaries (AppImage/.deb/.rpm/installer/portable).<details>and its compiler requirements refreshed to match the C++20 reality (GCC 13+/Clang 16+/Apple Clang 15+).