gmgauthier/sdrconnect-installer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(readme): enhance descriptions for license text handling and fallbacks

Browse Source 
- Update step 3 to include resolving and parsing license text from upstream, with fallback warning
- Adjust DONOTDOWNLOAD=1 flag description to cover skipping upstream lookup for hashes and license
- Expand default behavior explanation to mention license fetching, fallback, and yellow warning for potential drift
This commit is contained in:
Greg Gauthier 2026-05-03 15:37:29 +01:00
parent 9c7c3da5f5
commit e6abf28252
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -8,7 +8,7 @@ The official SDRPlay installer only supports Debian and Ubuntu. This script exte
1. Detects your Linux distribution and maps dependencies to the correct package names 1. Detects your Linux distribution and maps dependencies to the correct package names
2. Installs required system libraries (libusb, ALSA, hamlib, etc.) via your native package manager 2. Installs required system libraries (libusb, ALSA, hamlib, etc.) via your native package manager
3. Resolves the current SDRconnect and RigControl build hashes by parsing SDRPlay's official `install.sh`, falling back to built-in defaults if the upstream lookup fails 3. Resolves the current SDRconnect and RigControl build hashes *and* the current end-user licence text by parsing SDRPlay's official `install.sh`, falling back to built-in defaults if the upstream lookup fails (a prominent yellow warning is printed if the licence falls back, since the embedded copy may have drifted from upstream)
4. Downloads the SDRconnect and RigControl binaries from SDRPlay's servers 4. Downloads the SDRconnect and RigControl binaries from SDRPlay's servers
5. Verifies download integrity via SHA256 checksums 5. Verifies download integrity via SHA256 checksums
6. Installs both applications to `/opt/sdrconnect` and `/opt/rigcontrol` 6. Installs both applications to `/opt/sdrconnect` and `/opt/rigcontrol`
@ -58,13 +58,13 @@ The script will present the SDRPlay license agreement and prompt for acceptance
- `--dry-run` — Print what would be done without making changes - `--dry-run` — Print what would be done without making changes
- `ACCEPTLICENSE=1` — Skip the interactive license prompt - `ACCEPTLICENSE=1` — Skip the interactive license prompt
- `DONOTDOWNLOAD=1` — Use local tarballs instead of downloading (place them in the current directory). Also skips the upstream version lookup; pin filenames with the override variables below - `DONOTDOWNLOAD=1` — Use local tarballs instead of downloading (place them in the current directory). Also skips the upstream lookup (build hashes and licence text); pin filenames with the override variables below
- `NOTSUPPORTED=1` — Skip dependency checks entirely (install them yourself) - `NOTSUPPORTED=1` — Skip dependency checks entirely (install them yourself)
- `SYSTEMD_MODE=install SYSTEMD_TARGET=sdrconnectserver` — Enable the server systemd service - `SYSTEMD_MODE=install SYSTEMD_TARGET=sdrconnectserver` — Enable the server systemd service
- `SDRCONNECT_GITBUILD=<hash>` — Pin the SDRconnect build hash, bypassing the upstream lookup - `SDRCONNECT_GITBUILD=<hash>` — Pin the SDRconnect build hash, bypassing the upstream lookup
- `RIGCONTROL_GITBUILD=<hash>` — Pin the RigControl build hash, bypassing the upstream lookup - `RIGCONTROL_GITBUILD=<hash>` — Pin the RigControl build hash, bypassing the upstream lookup
By default the installer fetches the current build hashes from SDRPlay's official `install.sh` at runtime, so it tracks new releases without needing edits. If that fetch fails, it falls back to a pair of built-in hashes baked into the script. By default the installer fetches the current build hashes *and* the current licence text from SDRPlay's official `install.sh` at runtime, so it tracks both new releases and licence updates without needing edits. If the fetch fails — or the licence block can't be parsed out — it falls back to copies baked into the script and prints a prominent yellow warning so you know the displayed licence may not match the current upstream version.
### Adding support for a new distro family ### Adding support for a new distro family