Update README.md for Quick Connect, RDP clipboard sync, latest release

README.md hadn't been touched since v2026.9.16.7 and had drifted:
Quick Connect (issue #23) was undocumented, RDP's own clipboard sync
was missing from its feature list (only VNC's was listed), and the
"latest release" pointed at a stale version with a note about a draft
that has long since published.

Also adds CLAUDE.md with a release checklist so README.md gets checked
for drift as a standard part of every release going forward, per user
request, instead of falling behind until someone notices.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
ksmithandClaude Sonnet 5 committed 2026-09-28 16:53:04 -06:00
1 parent 988637eb39
commit e6023a884f
2 files changed
+28 -4

No files matched your search

+20
View File
@@ -0,0 +1,20 @@
# OrbitHub
## Release checklist
Every release (new tag + build + publish) must include:
- **Update `README.md`** to match current reality before tagging:
latest published release version/link, the Implemented Features list
(add/adjust bullets for anything shipped since the last release), and
any status notes (e.g. VNC/Apple-auth caveats) that changed.
- Update `docs/PROGRESS.md` with a bullet describing what shipped.
- Bump the version in `CMakeLists.txt`.
- Build and test all reachable platforms (Linux local, Windows and macOS
over SSH — see prior release commits/sessions for the build scripts
used) before publishing.
`docs/USER_GUIDE.md` (in-app `Help -> User Guide` and the release PDF)
should also be checked for drift when a change affects user-facing
behavior, though it doesn't need a pass on every single release the way
README.md does.
+8 -4
View File
@@ -15,9 +15,7 @@ OrbitHub is in active development.
- Milestones completed: M0-M9
- Current milestone: Milestone 10 (v1.0 Stabilization)
- Latest published release: `v2026.9.16`; a `v2026.9.16.6` release is
drafted with several post-`.16` fixes and is pending a macOS installer
before publishing
- Latest published release: `v2026.9.28`
- VNC (M6) is fully built out: Raw/CopyRect/Hextile/ZRLE/Tight encodings,
bidirectional clipboard sync, remote cursor shape sync, and both
scale-to-fit and actual-size display modes. Standard VNC Authentication
@@ -31,7 +29,7 @@ Progress and milestone details:
- [docs/PROGRESS.md](docs/PROGRESS.md)
Latest published release (installers for Windows, Linux, and macOS):
- [v2026.9.16](https://git.darksingularity.org/DarkSingularity/orbithub/releases/tag/v2026.9.16)
- [v2026.9.28](https://git.darksingularity.org/DarkSingularity/orbithub/releases/tag/v2026.9.28)
User Guide:
- [docs/USER_GUIDE.md](docs/USER_GUIDE.md) (also available as a PDF attached to each release, and in-app via `Help -> User Guide`)
@@ -69,6 +67,10 @@ An embedded RDP session in a tab.
- Drag-and-drop profile moves between folders with persistence
- Import/Export of the whole profile list as JSON, and one-way import from
mRemoteNG connection XML files (passwords are never imported)
- Quick Connect: open a session without saving a profile first (`File`
menu or a button on the Profiles tab); a "Save as Profile..." action on
the resulting tab persists it afterward, pre-filled with what was
entered
### Session Experience
@@ -97,6 +99,7 @@ An embedded RDP session in a tab.
- Resize handling and resolution renegotiation
- Domain-aware authentication support
- RDP security/performance profile options
- Bidirectional clipboard sync
### VNC
@@ -122,6 +125,7 @@ An embedded RDP session in a tab.
- `File` menu:
- New Profile
- New Folder
- Quick Connect...
- Import Profiles...
- Export Profiles...
- Import from mRemoteNG...