Bump to v1.8.0: updater hardening + plain-language manual rewrite
Updater (RemSoundUpdater.cs), all from Andre's feedback: * CheckForUpdateAsync now requests /releases?per_page=100 instead of the default 30-item page, so a burst of server-vX.Y relay releases can't push the newest client release off page 1. * The install helper's robocopy now excludes remsound.config.json and the logs / profiles / recordings folders — an update replaces app files only and can never overwrite the user's own config or data. * On a successful update the helper now also deletes _update-helper.log and any stale update-failed.txt (the _update folder was already removed), leaving a tidy install folder. The failure branch still keeps them all for diagnosis. * update-failed.txt rewritten as plain user-facing instructions: numbered steps, no brand names, names the real _update folder, no robocopy jargon. The exit code now goes to _update-helper.log only. Manual (readme.html): rewritten in plain language — developer jargon removed or explained in everyday terms — and a second pass removed the keystroke-navigation choreography and screen-reader narration from the prose. The Keyboard shortcuts section and all shortcut reference are kept intact. No wire-format or audio-pipeline changes — v1.5 through v1.8 interoperate. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 4.7
parent
6b1ae2d017
commit
e6d47e229d
+13
-8
@@ -1,16 +1,21 @@
|
||||
# RemSound v1.7
|
||||
# RemSound v1.8
|
||||
|
||||
A self-updater fix. Wire format and audio pipeline are unchanged from v1.4 / v1.5 / v1.6 — all releases interoperate.
|
||||
Updater improvements and a rewritten user manual. Wire format and audio pipeline are unchanged from v1.4 onward — all versions interoperate.
|
||||
|
||||
## Bug fix
|
||||
## Updater improvements
|
||||
|
||||
- **Check for updates now reliably finds RemSound releases.** RemSound and the RemSound relay server are published from the same GitHub repository; the relay's releases use `server-` prefixed tags. The updater previously asked GitHub only for the single newest release of *any* kind — so whenever a relay release was the most recent, the updater misread its version and concluded RemSound was already up to date, silently skipping a real client update. The updater now scans the full release list and considers only RemSound client versions, ignoring server releases, drafts and pre-releases.
|
||||
- **Check for updates is more reliable.** It now looks further down the GitHub release list when deciding what the newest version is, so it always finds the latest RemSound release.
|
||||
- **An update can no longer overwrite your own data.** The update now replaces RemSound's program files only — it leaves your settings file, and your profiles, logs and recordings folders, untouched. Previously a release package could in principle carry stray files over the top of yours; the updater now refuses to copy those even if they were present.
|
||||
- **A successful update leaves a tidy folder.** Once an update finishes cleanly, the temporary update files, the update log, and any leftover failure note are all cleared automatically.
|
||||
- **The "update failed" note is now plain English.** If an update can't finish, the `update-failed.txt` note left next to RemSound is written in clear, non-technical language with simple numbered steps. Technical detail for support stays in the separate update log.
|
||||
|
||||
If your copy is stuck on an older version because of this, install v1.7 once by hand (below) — from v1.7 onward, **Help → Check for updates** works correctly on its own.
|
||||
## Rewritten user manual
|
||||
|
||||
The user manual (press F1 inside RemSound, or open `readme.html`) has been rewritten from the ground up in plain language. Technical jargon has been removed or explained in everyday terms, and the writing now describes what to do rather than narrating keystrokes.
|
||||
|
||||
## Install
|
||||
|
||||
1. Download `RemSound-v1.7.zip` from this release.
|
||||
1. Download `RemSound-v1.8.zip` from this release.
|
||||
2. Extract somewhere with write permission (e.g. `C:\RemSound\`, `Documents\RemSound\`). Avoid `Program Files` unless you grant write permission so the self-updater can replace files in place.
|
||||
3. Run `RemSound.exe`. Allow on private networks when Windows Firewall prompts.
|
||||
4. Press F1 (or use the Help menu) for the user manual.
|
||||
@@ -19,6 +24,6 @@ Requires the .NET 10 Desktop Runtime. If it's missing, Windows offers to fetch i
|
||||
|
||||
## Upgrading
|
||||
|
||||
v1.5 / v1.6 users: use **Help → Check for updates** — it pulls v1.7 cleanly (their updater can still see v1.7 as long as it's the newest release at check time). To be certain, the manual install above always works.
|
||||
v1.5 / v1.6 / v1.7 users: use **Help → Check for updates** — it pulls v1.8 cleanly. The manual install above always works too.
|
||||
|
||||
If you installed RemSound inside a Dropbox-synced (or other file-sync) folder and your install is v1.0 / v1.1 / v1.2, see the [v1.3 release notes](https://github.com/Ednunp/RemSound/releases/tag/v1.3) for one-time manual install steps. From v1.3 onward Check-for-updates handles Dropbox correctly.
|
||||
If you installed RemSound inside a Dropbox-synced (or other file-sync) folder and your install is v1.0 / v1.1 / v1.2, see the [v1.3 release notes](https://github.com/Ednunp/RemSound/releases/tag/v1.3) for one-time manual install steps. From v1.3 onward Check-for-updates handles synced folders correctly.
|
||||
|
||||
Reference in New Issue
Block a user