Skip to content

Add Windows and macOS README examples - #7

Merged
tobyrjackson merged 3 commits into
mainfrom
docs/windows-macos-examples
Nov 17, 2026
Merged

tobyrjackson merged 3 commits into
mainfrom
docs/windows-macos-examples

Conversation

@tobyrjackson

@tobyrjackson tobyrjackson commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

The README has no Windows or macOS commands for the Akiki engine. Add PowerShell and Terminal examples for virtual environments, wheel installation, VAD, and local decision-model inference. Cover Windows x64, macOS Intel, and macOS Apple Silicon.

Use normal PyPI installation commands for the next published package. Give separate Windows PowerShell and macOS Terminal instructions. Include virtual environments, platform requirements, and the ONNX VAD compatibility fallback. Update the current decision-runtime platform list.

Validation: 92 packaging and CLI tests passed offline. Ruff checks passed. All 16 Python examples parsed, all 14 Bash examples passed syntax checks, and internal README links resolved. GitHub CI passed. This change updates documentation only. The desktop builds passed in workflow run 44155378050.

Fixes #3.

@tobyrjackson tobyrjackson left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please rewrite for the published version. we will publish to pypi later this evening

@tobyrjackson

Copy link
Copy Markdown
Contributor Author

Updated in 87f82a8. The Windows and macOS examples now install akiki from PyPI in a virtual environment. I removed the CI artifact steps, local wheel filenames, and temporary 0.2.1 instructions. The README describes the next published package, as requested.

GitHub CI passed. The packaging and CLI checks passed offline.

@tobyrjackson
tobyrjackson merged commit d937034 into main Nov 17, 2026
4 checks passed
@tobyrjackson
tobyrjackson deleted the docs/windows-macos-examples branch November 17, 2026 20:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README.md needs windows/macOS examples

1 participant