Skip to content

Commit cbdfc2c

Browse files
committed
docs: hyphens instead of em dashes; one sentence per line in paragraphs
Markdown house style: plain hyphens for true-text, and each sentence of a paragraph on its own line so a one-word change shows as a one-line diff. Lists, tables, code blocks, headings, and templates untouched.
1 parent aa04eb1 commit cbdfc2c

9 files changed

Lines changed: 147 additions & 203 deletions

File tree

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
- [ ] No admin rights required
2727
- [ ] Nothing blocks on network access (offline-first)
2828
- [ ] Discovery code sends query commands only
29-
- [ ] Log output uses `Serilog` — no `Console.WriteLine` or `Debug.WriteLine`
29+
- [ ] Log output uses `Serilog` - no `Console.WriteLine` or `Debug.WriteLine`
3030
- [ ] I have read CONTRIBUTING.md and agree to the CLA
3131

3232
## Related Issues

‎.github/SECURITY.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,14 @@
22

33
## Supported Versions
44

5-
RigCheck is pre-release. Only the most recent alpha or beta build is supported.
5+
RigCheck is pre-release.
6+
Only the most recent alpha or beta build is supported.
67

78
## Reporting a Vulnerability
89

910
**Please do not open a public GitHub issue for security vulnerabilities.**
1011

11-
Report security issues privately via GitHub's
12-
[Security Advisories](https://github.com/Computer-Tsu/ShackDesk-RigCheck/security/advisories/new)
13-
feature, or email the maintainer directly (see profile).
12+
Report security issues privately via GitHub's [Security Advisories](https://github.com/Computer-Tsu/ShackDesk-RigCheck/security/advisories/new) feature, or email the maintainer directly (see profile).
1413

1514
Include:
1615

‎.github/workflows/translations.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,10 +88,10 @@ jobs:
8888
8989
$statusText = switch ($status) {
9090
'reviewed' { 'Reviewed' }
91-
'machine-translated' { 'Machine translated — review wanted' }
91+
'machine-translated' { 'Machine translated - review wanted' }
9292
default { 'In progress' }
9393
}
94-
if ($pct -lt 100 -and $status -eq 'reviewed') { $statusText = 'Reviewed — new strings need translating' }
94+
if ($pct -lt 100 -and $status -eq 'reviewed') { $statusText = 'Reviewed - new strings need translating' }
9595
9696
$rows += "| $name (``$tag``) | ``$($file.Name)`` | $pct% ($translated of $total) | $statusText |"
9797
if ($translator) { $translators += "| $name | $translator |" }
@@ -106,7 +106,7 @@ jobs:
106106
$credits = if ($translators.Count -gt 0) {
107107
@('| Language | Translator |', '| --- | --- |') + $translators
108108
} else {
109-
@('_No community translations yet — yours could be the first. See [TRANSLATING.md](TRANSLATING.md)._')
109+
@('_No community translations yet - yours could be the first. See [TRANSLATING.md](TRANSLATING.md)._')
110110
}
111111
112112
function Replace-Between([string]$path, [string]$startMarker, [string]$endMarker, [string[]]$lines) {

‎CHANGELOG.md‎

Lines changed: 32 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Version numbers: patch (x.x.1) for landed features and fixes, minor (x.1.0) for
1212
Takes effect on the next start. Until now the language could only follow Windows
1313

1414
### Changed
15-
- The exported log's transcript section is headed "Commands and replies" — it holds Run Tests
15+
- The exported log's transcript section is headed "Commands and replies" - it holds Run Tests
1616
exchanges as well as Find my radio's
1717
- The hex dump shows its ASCII column only when most bytes are printable, so CI-V frames no
1818
longer carry a column of dots
@@ -23,7 +23,7 @@ Run Tests works without Hamlib, and says whose fault a failure is.
2323

2424
### Added
2525
- **Radio check (direct):** Run Tests now starts by speaking the radio's own protocol over the
26-
port — identity, frequency, mode, PTT state, S-meter — for Icom CI-V and the
26+
port - identity, frequency, mode, PTT state, S-meter - for Icom CI-V and the
2727
Kenwood/Elecraft/Yaesu CAT families, with no Hamlib involved. On a PC without Hamlib this is
2828
the whole test and it proves the radio, cable, port, and speed. Every byte is in the transcript
2929
- **Verdict line** after the run: radio answers directly but Hamlib fails → the hardware is
@@ -44,12 +44,12 @@ Run Tests works without Hamlib, and says whose fault a failure is.
4444

4545
## [0.8.1] - 2026-09-21
4646

47-
0.8.x is the line after the first beta (0.7.2-beta, promoted 2026-09-21). Fixes for that beta
48-
land on `main` as 0.7.3-beta onward and are cherry-picked here.
47+
0.8.x is the line after the first beta (0.7.2-beta, promoted 2026-09-21).
48+
Fixes for that beta land on `main` as 0.7.3-beta onward and are cherry-picked here.
4949

5050
### Added
5151
- Update check: once a day at startup, one request to the GitHub Releases API, nothing
52-
downloaded. Channel-aware — stable users hear about stable releases only, beta users about
52+
downloaded. Channel-aware - stable users hear about stable releases only, beta users about
5353
betas and stables, alpha users about everything; the same number in a more trusted channel
5454
counts as newer (0.7.2-alpha → 0.7.2-beta). Result shows as "Update available: …" under Help
5555
(opens the release page) and in the status strip. Help › Check for updates asks on demand.
@@ -83,11 +83,9 @@ land on `main` as 0.7.3-beta onward and are cherry-picked here.
8383

8484
**Milestone: environment checks and Find my radio, proven on a real Icom IC-7300.**
8585

86-
Scan PC, Find my radio, and Run Tests all did their job on real hardware today. Everything the
87-
bench found — CI-V broadcast never answers, WSJT-X names its Hamlib `rigctl-wsjtx.exe`, the
88-
connection test hung in rigctl's interactive mode, Hamlib says nothing on failure without `-vv`,
89-
`get_vfo` is not a fault on Icoms — is fixed in 0.6.10 through 0.6.17 below. This is the version
90-
the first beta will be cut from.
86+
Scan PC, Find my radio, and Run Tests all did their job on real hardware today.
87+
Everything the bench found - CI-V broadcast never answers, WSJT-X names its Hamlib `rigctl-wsjtx.exe`, the connection test hung in rigctl's interactive mode, Hamlib says nothing on failure without `-vv`, `get_vfo` is not a fault on Icoms - is fixed in 0.6.10 through 0.6.17 below.
88+
This is the version the first beta will be cut from.
9189

9290
## [0.6.17] - 2026-09-21
9391

@@ -107,7 +105,7 @@ First all-green run on an IC-7300; one false pass corrected.
107105
- "Get VFO" reported a pass with a page of Hamlib trace as the VFO name. The IC-7300 (like most
108106
Icoms) has no get_vfo in Hamlib; rigctl printed "Feature not available" but still exited 0.
109107
Hamlib's own error line is now recognised whatever the exit code, and an unsupported query is a
110-
warning that says so — the radio is fine, the command just does not exist for it
108+
warning that says so - the radio is fine, the command just does not exist for it
111109
- Result messages show only the first line of rigctl's output, never a trace
112110

113111
## [0.6.15] - 2026-09-21
@@ -121,7 +119,7 @@ Failures now say why.
121119
messages ("serial port COM3 is already open", "does not exist", "failed to connect") drive the
122120
diagnosis
123121
- The "port in use" diagnosis names the program that is running right now (WSJT-X, Fldigi,
124-
JS8Call, Flrig, rigctld, Winlink Express, VARA) — checked only when that failure occurs
122+
JS8Call, Flrig, rigctld, Winlink Express, VARA) - checked only when that failure occurs
125123
- The suggested rigctld command uses the name that exists on the PC (`rigctld-wsjtx`) and omits
126124
`-s` when the baud is Radio default
127125
- The Quick preset picker shows the saved radio on startup instead of "Choose your radio…"
@@ -131,7 +129,7 @@ Failures now say why.
131129
Run Tests works against a real radio.
132130

133131
### Fixed
134-
- The "Open connection" test ran rigctl with no command, which does not connect-and-exit — it
132+
- The "Open connection" test ran rigctl with no command, which does not connect-and-exit - it
135133
enters rigctl's interactive mode and waits for keyboard input until RigCheck's timeout, so
136134
every run reported "the radio did not respond" and skipped the other six tests, even though
137135
Hamlib could talk to the radio in 7 ms. The test now reads the frequency, which proves the
@@ -155,7 +153,7 @@ WSJT-X's Hamlib is found.
155153

156154
### Added
157155
- When Scan PC finds no Hamlib, the diagnosis shows the one-line winget command that installs
158-
WSJT-X (`winget install JoeTaylor.WSJT-x`) as a copyable fix — RigCheck never runs it
156+
WSJT-X (`winget install JoeTaylor.WSJT-x`) as a copyable fix - RigCheck never runs it
159157

160158
### Fixed
161159
- Summary line reads "115200 baud, 8N1 (8 data bits, no parity, 1 stop)" instead of "1 stop bit(s)"
@@ -164,8 +162,8 @@ WSJT-X's Hamlib is found.
164162
## [0.6.11] - 2026-09-21
165163

166164
### Added
167-
- Find my radio ends with the sentence the operator came for — "Your radio: Icom IC-7300 on COM3
168-
— 115200 baud, 8 data bits, no parity, 1 stop bit" — in the results and in the status bar
165+
- Find my radio ends with the sentence the operator came for - "Your radio: Icom IC-7300 on COM3
166+
- 115200 baud, 8 data bits, no parity, 1 stop bit" - in the results and in the status bar
169167

170168
## [0.6.10] - 2026-09-21
171169

@@ -176,8 +174,8 @@ First lessons from a real IC-7300.
176174
(broadcast), which rigs act on but by design never answer. When only our own echo comes
177175
back (Echo Back is on by default on the IC-7300) or nothing at all, RigCheck now addresses
178176
each CI-V address in `rig_ids.json` in turn, the selected radio's first
179-
- Our own frame echoed back is now reported as what it is — a CI-V radio listening at that
180-
speed — instead of "nothing recognisable"
177+
- Our own frame echoed back is now reported as what it is - a CI-V radio listening at that
178+
speed - instead of "nothing recognisable"
181179
- Without Hamlib installed, Find my radio reported a found radio as unverified because the
182180
rigctl tests could not run. A radio that named itself over the serial port now counts as
183181
verified, the Connection panel is filled in, and the handoff is shown; the note says to
@@ -200,12 +198,12 @@ Find my radio hands you the settings; Hamlib's dummy rig can no longer pass unno
200198
Radio), Fldigi (Rig Control › Hamlib), and Winlink Express, each as one copyable line
201199
- RigCheck reads what WSJT-X and JS8Call are configured to use (`WSJT-X.ini`, `JS8Call.ini`):
202200
their port is probed first, their radio stands in when none is chosen, and after the sweep
203-
each program gets a one-line verdict — already matches, or exactly which fields to change
201+
each program gets a one-line verdict - already matches, or exactly which fields to change
204202
- The raw console warns beside every command sent to Hamlib model 1, the dummy rig
205203

206204
## [0.6.8] - 2026-09-21
207205

208-
Find my radio — the second half of the 0.7.0 milestone, first cut.
206+
Find my radio - the second half of the 0.7.0 milestone, first cut.
209207

210208
### Added
211209
- **Find my radio** button: tick the COM ports it may open, and it sweeps each with read-only
@@ -223,15 +221,15 @@ Find my radio — the second half of the 0.7.0 milestone, first cut.
223221
- Telemetry event `discovery` (ports swept, families/models/bauds that answered, verified count)
224222

225223
### Safety
226-
- RTS and DTR are never asserted during discovery — on many interfaces they are the PTT line
224+
- RTS and DTR are never asserted during discovery - on many interfaces they are the PTT line
227225
- The sweep only runs from the button, only on ticked ports, and sends read commands only
228226

229227
## [0.6.7] - 2026-09-21
230228

231229
First half of the 0.7.0 milestone: the PC-side checks.
232230

233231
### Added
234-
- **Scan PC** button: ten read-only checks that need no radio — Windows version, every Hamlib
232+
- **Scan PC** button: ten read-only checks that need no radio - Windows version, every Hamlib
235233
copy found and which one is used, `rigctl --version`, rigctl on PATH (with the `setx` fix
236234
shown), the selected radio model with a clear warning if it is Hamlib's dummy rig, serial
237235
driver problem codes, whether anything listens on the rigctld and Flrig ports, rigctld startup
@@ -263,7 +261,7 @@ Results you can select and copy; a heads-up when a run finishes.
263261
Every string translatable; translation contributor process in place.
264262

265263
### Added
266-
- Copy Results button — the same plain-text report as Export Log, to the clipboard
264+
- Copy Results button - the same plain-text report as Export Log, to the clipboard
267265
- All remaining user-visible text moved into `Strings.resx`: test names and messages, every
268266
diagnosis and help topic, the exported log, status messages, and the main window
269267
- Translation coverage workflow: the language table in `TRANSLATING.md` and the credits in
@@ -296,7 +294,7 @@ Radio and cable databases as data files.
296294
- Alpha release tags use the same `yyyyMMdd` stamp as the filename
297295

298296
### Removed
299-
- The "Flex 6300" preset, which pointed at Hamlib model 1 — the dummy rig — and would have
297+
- The "Flex 6300" preset, which pointed at Hamlib model 1 - the dummy rig - and would have
300298
reported every test as passing without touching a radio
301299

302300
### Fixed
@@ -322,7 +320,7 @@ Expiry, diagnostics, settings, and automated alpha releases.
322320
telemetry endpoint: a startup report and a per-test-run report with radio model, serial settings,
323321
USB cable identifiers, and test outcomes. Every report is stored locally and viewable under
324322
Help > View collected data. Support ID shown in Help > About.
325-
- Settings window: diagnostics toggle, log level (Off / Errors only / Normal / Detailed —
323+
- Settings window: diagnostics toggle, log level (Off / Errors only / Normal / Detailed -
326324
Detailed by default on test builds), log folder path with Open and Delete buttons, Support ID
327325
with Copy and Reset. Changes apply on OK; Cancel discards them.
328326
- Unhandled exceptions are logged, reported if diagnostics are on, and shown to the operator
@@ -364,12 +362,12 @@ First launch feedback and the move to .NET 10.
364362

365363
## [0.6.1] - 2026-09-21
366364

367-
First successful build. The application compiles in CI and produces a
368-
self-contained executable.
365+
First successful build.
366+
The application compiles in CI and produces a self-contained executable.
369367

370368
### Added
371369
- CI build workflow producing the self-contained exe and its SHA-256 as an artifact
372-
- `app.manifest` — runs as standard user, per-monitor DPI aware
370+
- `app.manifest` - runs as standard user, per-monitor DPI aware
373371
- Placeholder application icon (to be replaced with final artwork)
374372
- Help topics shown alongside timeout and no-response failures
375373
- Main window code-behind: window position persistence, console Enter/Up/Down key handling
@@ -385,12 +383,13 @@ self-contained executable.
385383
- Dependency-injection registrations for services and ViewModels not yet implemented
386384

387385
### Fixed
388-
- rigctl timeout was never detected — `Task.WaitAsync` throws on timeout rather than returning false
386+
- rigctl timeout was never detected - `Task.WaitAsync` throws on timeout rather than returning false
389387
- Missing `System.IO.Ports` and `Serilog.Extensions.Hosting` package references
390388

391389
## [0.6.0] - 2026-09-20
392390

393-
Project structure and licensing milestone. No functional changes to the application.
391+
Project structure and licensing milestone.
392+
No functional changes to the application.
394393

395394
### Added
396395
- GPLv3 license
@@ -406,13 +405,12 @@ Project structure and licensing milestone. No functional changes to the applicat
406405
- README gains license badge, Contributing, and License sections
407406

408407
### Removed
409-
- `CommercialTier` branding constant and `LicenseService` registration — monetization is deferred until closer to a stable release
408+
- `CommercialTier` branding constant and `LicenseService` registration - monetization is deferred until closer to a stable release
410409

411410
### Fixed
412411
- Missing `System.Management` package reference required by COM port enumeration
413412

414413
## [0.5.0] - 2026-04-07
415414

416-
Initial scaffold: WPF/MVVM project structure, service layer for Hamlib location and
417-
invocation, COM port enumeration, diagnosis engine, settings, and log export. Feature
418-
specification in README.
415+
Initial scaffold: WPF/MVVM project structure, service layer for Hamlib location and invocation, COM port enumeration, diagnosis engine, settings, and log export.
416+
Feature specification in README.

‎CLA.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Plain English Summary
44

5-
*This summary is not legal text — the full agreement is below.*
5+
*This summary is not legal text - the full agreement is below.*
66

77
- **You keep ownership** of everything you contribute. You are not giving up your copyright.
88
- **You give permission** for your contribution to be used in the GPL-licensed source

‎LEGAL.md‎

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,18 @@ RigCheck™ and ShackDesk™ are trademarks of My Computer Guru LLC.
88

99
## License
1010

11-
Source code in this repository is licensed under the GNU General Public License,
12-
version 3 ([LICENSE](LICENSE)).
11+
Source code in this repository is licensed under the GNU General Public License, version 3 ([LICENSE](LICENSE)).
1312

14-
Use of the RigCheck or ShackDesk names, logos, branding, or identity in derived
15-
products is not permitted without written permission. This trademark restriction
16-
is separate from, and in addition to, the terms of the GPL.
13+
Use of the RigCheck or ShackDesk names, logos, branding, or identity in derived products is not permitted without written permission.
14+
This trademark restriction is separate from, and in addition to, the terms of the GPL.
1715

1816
---
1917

2018
## Trademark Notices
2119

2220
The following are trademarks or registered trademarks of their respective owners.
23-
RigCheck is not affiliated with, endorsed by, or sponsored by any of these companies
24-
or projects. References are for interoperability and identification purposes only.
21+
RigCheck is not affiliated with, endorsed by, or sponsored by any of these companies or projects.
22+
References are for interoperability and identification purposes only.
2523

2624
| Trademark | Owner |
2725
| ----------- | ------- |
@@ -39,19 +37,17 @@ or projects. References are for interoperability and identification purposes onl
3937
| Winlink | Winlink Development Team |
4038
| OmniRig | Alex Shovkoplyas (VE3NEA) |
4139

42-
All other product names, company names, and trademarks mentioned in RigCheck or its
43-
documentation are the property of their respective owners.
40+
All other product names, company names, and trademarks mentioned in RigCheck or its documentation are the property of their respective owners.
4441

4542
---
4643

4744
## Third-Party Software
4845

4946
### Hamlib
5047

51-
RigCheck invokes the Hamlib `rigctl` utility as a separate process. It does not link
52-
against or bundle the Hamlib library. Hamlib is licensed under the LGPL (library) and
53-
GPL (utilities) and is available from
54-
[github.com/Hamlib/Hamlib](https://github.com/Hamlib/Hamlib).
48+
RigCheck invokes the Hamlib `rigctl` utility as a separate process.
49+
It does not link against or bundle the Hamlib library.
50+
Hamlib is licensed under the LGPL (library) and GPL (utilities) and is available from [github.com/Hamlib/Hamlib](https://github.com/Hamlib/Hamlib).
5551

5652
### Libraries
5753

@@ -67,5 +63,4 @@ GPL (utilities) and is available from
6763
| CommunityToolkit.Mvvm | MIT | © .NET Foundation and contributors | [CommunityToolkit/dotnet](https://github.com/CommunityToolkit/dotnet) |
6864
| Newtonsoft.Json | MIT | © James Newton-King | [JamesNK/Newtonsoft.Json](https://github.com/JamesNK/Newtonsoft.Json) |
6965

70-
USB device identification data sourced in part from the
71-
[USB ID Repository](https://usb-ids.gowdy.us/) and community contributions.
66+
USB device identification data sourced in part from the [USB ID Repository](https://usb-ids.gowdy.us/) and community contributions.

0 commit comments

Comments
 (0)