Update README#1359
Conversation
Are we sure we want to do this? We are not actually changing to have any stronger guarantees of support or API compatibility or whatnot right now, I think. |
dd5297e to
86d63de
Compare
Added back another version of it |
There was a problem hiding this comment.
Pull request overview
This PR refreshes the introductory documentation for Hyperlight by making the README shorter, moving setup details into a new getting-started guide, and updating guest-building guidance around newer macro-based guest patterns.
Changes:
- Condenses
README.mdwith a shorter overview, examples, repository table, and community/project links. - Adds
docs/getting-started.mdfor prerequisites, platform setup, quick start, and troubleshooting. - Updates guest-binary documentation and links the new getting-started guide from the docs index.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
README.md |
Replaces the longer README with a concise project overview, examples, setup pointers, and repository structure. |
docs/README.md |
Adds the new getting-started guide to further reading. |
docs/how-to-build-a-hyperlight-guest-binary.md |
Reworks Rust guest documentation around hyperlight-guest-bin macros and adds scaffold/build guidance. |
docs/getting-started.md |
Adds prerequisites, platform-specific setup, quick-start commands, troubleshooting, and codespaces guidance. |
Signed-off-by: Ludvig Liljenberg <4257730+ludfjig@users.noreply.github.com>
|
This is now ready since https://github.com/hyperlight-dev/cargo-hyperlight/releases/tag/v0.1.11 was released! |
Updates the README to be more concise, shortens the example code, and splits prereqs into separate getting-started md. Removes the scary sounding
Note: Hyperlight is a nascent project with an evolving API and no guaranteed support. Assistance is provided on a best-effort basis by the developers.in favor for less scary sounding**Status:** Hyperlight is pre-1.0. The API may change between releases, and upgrading will sometimes require code changes.cargo hyperlight scaffoldPR is still not merged so shouldn't merge this until that is merged(and released).Rendered