Repository navigation
Add platform support to README - #1967
Open
yoshuawuyts wants to merge 1 commit into
Open
yoshuawuyts wants to merge 1 commit into
yoshuawuyts wants to merge 1 commit into
Conversation
Signed-off-by: Yosh <github@yosh.is>
yoshuawuyts
requested review from
andreiltd,
danbugs,
dblnz,
devigned,
jprendes,
jsturtevant,
ludfjig,
simongdavies,
squillace and
syntactically
as code owners
October 21, 2026 09:42
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation-only changes have one minor, nonblocking accuracy correction.
1 open issue
What changed in this PR
The README documents Hyperlight’s platform and feature support.
Changes:
- Adds support tables for Linux, Windows, and macOS.
- Lists hypervisor, debugger, and crash dump availability.
- Formats the repository structure table.
| File | Description |
|---|---|
| README.md | Documents platform support and formats existing tables. |
Review effort: Balanced
| | ------------ | ---------- | --------------- | -------- | ---------- | | ||
| | aarch64 | HVF | ✅ Yes | ❌ No | ❌ No | | ||
|
|
||
| ¹ Not yet covered by CI |
simongdavies
left a comment
simongdavies
left a comment
Member
There was a problem hiding this comment.
At line 14 the README says "Supports KVM, MSHV, and Windows Hypervisor Platform".
We should probably add AVF/HVF there or remove that line.
Also as copilot noted we do have CI for Windows/WHP/ARM so I think it should be noted as supported not experimental
|
|
||
| ### Linux | ||
|
|
||
| | Architecture | Hypervisor | General support | Debugger | Crashdumps | |
Member
There was a problem hiding this comment.
nit: should we make the headers "Guest Debugging"/ Guest Crashdumps?
This branch has not been deployed
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
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.
This came from a conversation yesterday with @simongdavies, but we're currently not communicating our platform support clearly anywhere. That includes base hypervisor support, but also support for features like debugging and crash dumps.
The second part of the diff here is because I ran "format tables" on the entire file. I figured that would make it a bit more legible, so I kept it in.
I hope I got all the info right in the table; please have a look. Thanks!