docs: restructure README into 5-section layout#770
Merged
Conversation
timenick
reviewed
May 28, 2026
timenick
reviewed
May 28, 2026
timenick
reviewed
May 28, 2026
timenick
reviewed
May 28, 2026
- Add WinML CLI wheel row with Releases link to Prerequisites table - Remove redundant requires-python parenthetical from Python row - Mark MIGraphX as coming soon (not ready) in hardware table and Scope
timenick
reviewed
May 28, 2026
Co-authored-by: Zhipeng Wang <zhiwang@microsoft.com>
Co-authored-by: Zhipeng Wang <zhiwang@microsoft.com>
DingmaomaoBJTU
approved these changes
May 28, 2026
timenick
approved these changes
May 28, 2026
DingmaomaoBJTU
added a commit
that referenced
this pull request
Jun 5, 2026
## Summary - Reorganized README into 5 sections: Title + Description, Features / Scope, Getting Started, Commands, Contributing + License - Updated status badge to `preview`, rewrote description and Features (✅ bullets) - Scope section: added supported EPs, built-in model catalog reference, accepted inputs; removed verbose LLM/not-supported block - Getting Started: consolidated Prerequisites + Installation + Quick Start; added Config-Build Pipeline and Step-by-step through primitive commands walkthroughs - Commands: BYOM workflow with pipeline diagram, command table + collapsible details, comparison table (Config-Driven first) - Reference tables at end: Supported Hardware, Supported Tasks, Supported Model Types, Built-in Models --------- Co-authored-by: Qiong Wu (qiowu) <qiowu@microsoft.com> Co-authored-by: Zhipeng Wang <zhiwang@microsoft.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
preview, rewrote description and Features (✅ bullets)