docs: update README

This commit is contained in:
Kavish Devar
2026-05-15 23:35:26 +05:30
parent 362e34202a
commit 154ed17c05
4 changed files with 298 additions and 107 deletions

View File

@@ -1,3 +1,26 @@
# LibrePods on Linux
A new rewrite is being worked upon. Please look at the list of features in the root README to see what's supported in the new version.
The rewrite can be found in the `linux/rust` branch [here](https://github.com/kavishdevar/librepods/tree/linux/rust/linux-rust). Follow the development in [PR #241](https://github.com/kavishdevar/librepods/pull/241).
## Installation
### GitHub Releases
The app is ready to download as an AppImage or an executable. You can download the latest pre-release from the [GitHub releases](https://github.com/kavishdevar/librepods/releases?q="linux-v0").
### Nightly Builds (recommended)
You can also try the latest build of the new version from the [GitHub Actions artifacts](https://github.com/kavishdevar/librepods/actions/workflows/ci-linux-rust.yml). On the latest successful workflow run, download the **librepods-x86_64.AppImage** or **librepods** binary from **Artifacts**.
![new version screenshot](https://github.com/user-attachments/assets/86b3c871-89a8-4e49-861a-5119de1e1d28)
<details>
<summary>README for the old version</summary>
# LibrePods Linux
![screenshot](imgs/main-app.png)
@@ -189,3 +212,5 @@ It is possible that the AirPods disconnect after a short period of time and play
### Why a separate script?
Because I discovered that QBluetooth doesn't support connecting to a socket with its PSM, only a UUID can be used. I could add a dependency on BlueZ, but then having two bluetooth interfaces seems unnecessary. So, I decided to use a separate script for hearing aid features. In the future, QBluetooth will be replaced with BlueZ native calls, and then everything will be in one application.
</details>