docs(readme): add omlx (Apple Silicon MLX) to local runtime list#3
Conversation
Documentation-only. Lists omlx as an OpenAI-compatible local runtime alongside LM Studio, Ollama, and llama.cpp server, in all 8 README translations. README.md and README.zh-TW.md (the two with "Runtime notes" sections) also get a runtime-specific bullet describing the startup shape. omlx is an Apache-2.0 MLX inference server optimized for Apple Silicon (https://github.com/jundot/omlx). Its OpenAI-compatible API defaults to http://localhost:8000/v1/chat/completions, matching the existing preset format. No code changes. The runtime is reached via the existing openai-compatible provider with a user-entered endpoint. Refs PRINCIPLES.md "Keep Provider Choice Modular" and "Avoid Backend Lock-In". Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Documentation-only update that adds omlx (an Apple Silicon MLX inference server) as another OpenAI-compatible local runtime example across all 8 README translations. No code changes are required because the existing openai-compatible provider already accepts arbitrary user-configured endpoints.
Changes:
- Adds
omlx (Apple Silicon)to the local-runtime features bullet in all 8 READMEs. - Adds
omlx: http://localhost:8000/v1/chat/completionsto the endpoint preset code block in all 8 READMEs. - Adds an
omlxruntime-notes bullet (startup commands + default endpoint) only inREADME.mdandREADME.zh-TW.md, matching the existing structure (the other 6 translations don't carry a Runtime notes section).
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds omlx to features bullet, endpoint presets, and Runtime notes section. |
| README.zh-TW.md | Adds omlx to features bullet, endpoint presets, and Runtime notes section. |
| README.zh-CN.md | Adds omlx to features bullet and endpoint presets. |
| README.ja.md | Adds omlx to features bullet and endpoint presets. |
| README.ko.md | Adds omlx to features bullet and endpoint presets. |
| README.de.md | Adds omlx to features bullet and endpoint presets (ASCII-only spelling preserved). |
| README.es.md | Adds omlx to features bullet and endpoint presets (ASCII-only spelling preserved). |
| README.fr.md | Adds omlx to features bullet and endpoint presets (ASCII-only spelling preserved). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
English (en-US)Thanks for the PR. This is a useful addition for users running local models on Apple Silicon. I pushed a small follow-up commit to this PR branch to keep the documentation and Options UI aligned:
Local validation passed:
GitHub Actions currently show 繁體中文感謝提交這個 PR。這對使用 Apple Silicon 跑本機模型的使用者很有幫助。 我已經直接在這個 PR branch 補了一個小 commit,讓文件和 Options UI 保持一致:
本機驗證已通過:
目前 GitHub Actions 顯示 |
|
@fredchu 感謝 PR,覺得溫馨 |
|
@linyiru Lawrence 大大好久不見哈哈,發現優質專案來看看有沒有能貢獻的地方而已 🙈 |
Documentation-only. Lists
omlxas an OpenAI-compatible local runtime alongside LM Studio, Ollama, and llama.cpp server, in all 8 README translations.README.mdandREADME.zh-TW.md(the two files with "Runtime notes" sections) also get a runtime-specific bullet describing the startup shape.What
omlx (Apple Silicon)to the "local OpenAI-compatible runtimes" feature bullet.omlx: http://localhost:8000/v1/chat/completionsto the endpoint preset code block.README.md+README.zh-TW.md: add one Runtime-notes bullet describingomlx serve/omlx serve --model-dir /path/to/modelsstartup, with the OpenAI-compatible endpoint athttp://localhost:8000/v1/chat/completions.Why
omlx is an Apache-2.0 MLX inference server optimized for Apple Silicon. Its OpenAI-compatible API defaults to
http://localhost:8000/v1/chat/completions, matching the existing preset format. Margin users on M-series Macs are a natural audience for it.No code changes are required — the runtime is reached via the existing OpenAI Compatible provider with a user-entered endpoint.
Alignment
PRINCIPLES.md→ Keep Provider Choice Modular: documents another OpenAI-compatible local endpoint without adding a new provider adapter.PRINCIPLES.md→ Avoid Backend Lock-In: still uses the user-configured endpoint path; no official backend introduced.PRINCIPLES.md→ Keep the MVP Narrow: no scope expansion (no new feature, no new file type).Translation discipline
zh-CN,ja,ko,de,es,fr) — which don't currently contain a "Runtime notes" section — only get the features-bullet + code-block changes, matching their existing structure.🤖 Generated with Claude Code