docs: rewrite README in Simplified Technical English

[JarbasAl]

Rewrites the README for clarity and adds a Related projects section linking wakeforge, ovos-plugin-manager, and the sibling ovos-ww-plugin-precise-onnx. No facts, config keys, or credits were changed.

Rewritten by Claude Sonnet 5 using the ste-writing skill (authored and reviewed by Claude Fable 5); linted with ste_lint.py.

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Clarified the plugin’s processing pipeline and runtime requirements.
  • Documented that PyTorch is not required.
  • Simplified configuration guidance.
  • Added links to related projects and plugins.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: bcc8119e-04a3-443a-8a31-f6ce61f36b55

📥 Commits

Reviewing files that changed from the base of the PR and between 34c995c and 5aa804d.

📒 Files selected for processing (1)

• README.md

---

📝 Walkthrough

Walkthrough

The README now explains the wakeforge/ONNX pipeline, runtime dependencies, configuration options, and related projects.

Changes

README documentation update

Layer / File(s)	Summary
README content and references README.md	The README documents single-phrase training, the two-file ONNX pipeline, runtime dependencies, and the lack of PyTorch requirements. It simplifies configuration guidance and adds related project links.

Estimated code review effort: 1 (Trivial) | ~2 minutes

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/ste-readme

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[github-actions]

Beep boop! Here's the latest status of your PR checks. 🤖

I've aggregated the results of the automated checks for this PR below.

📋 Repo Health

Checking the repo's cholesterol levels (aka code bloat). 🥩

✅ All required files present.

Latest Version: 0.0.1a1

✅ ovos_ww_plugin_wakeforge/version.py — Version file
✅ README.md — README
✅ LICENSE — License file
✅ pyproject.toml — pyproject.toml
⚠️ setup.py — setup.py
⚠️ CHANGELOG.md — Changelog
✅ ovos_ww_plugin_wakeforge/version.py has valid version block markers

⚖️ License Check

Ensuring no copyleft violations in this PR. ⬅️

✅ No license violations found.

Policy: Apache 2.0 (universal donor). StrongCopyleft / NetworkCopyleft / WeakCopyleft / Other / Error categories fail. MPL allowed.

🏷️ Release Preview

A sneak peek at the future of OpenVoiceOS. 🔮

Current: 0.0.1a1 → Next: 0.0.1a2

Signal	Value
Label	(none)
PR title	docs: rewrite README in Simplified Technical English
Bump	alpha

✅ PR title follows conventional commit format.

---

🚀 Release Channel Compatibility

Predicted next version: 0.0.1a2

Channel	Status	Note	Current Constraint
Stable	⚪	Not in channel	-
Testing	⚪	Not in channel	-
Alpha	⚪	Not in channel	-

🔍 Lint

The automated gnomes have finished their shift. 🍄

❌ ruff: issues found — see job log

🔒 Security (pip-audit)

I've scanned the dependencies for any hidden surprises. 🔍

✅ No known vulnerabilities found (70 packages scanned).

🔌 Plugin Detection

Plugin compatibility check: looking good! 🔌

❌ Plugin Status: ERRORS (1)

Plugin Info:

• Name: ovos-ww-plugin-wakeforge
• Description: OVOS wake word plugin for models trained with wakeforge

Plugin Types: wake_word

OPM Detection:

Plugin Type	Wheel	Editable
wake_word	✅	✅

Entry Point Validation:

Entry Point	Type	Import	Interface
ovos-ww-plugin-wakeforge	wake_word	✅ 2343ms	✅

⊘ No settingsmeta.json
✅ requires-python >=3.10 — running Python 3.11

Issues:

• ❌ Import time for ovos-ww-plugin-wakeforge exceeds 500ms (2343ms)
• ⚠️ No settingsmeta.json found
• ⚠️ No settingsmeta.json found

---

Automating the boring stuff so you don't have to! 🚀