Skip to content

Update README#1359

Open
ludfjig wants to merge 1 commit into
hyperlight-dev:mainfrom
ludfjig:fix_readme
Open

Update README#1359
ludfjig wants to merge 1 commit into
hyperlight-dev:mainfrom
ludfjig:fix_readme

Conversation

@ludfjig
Copy link
Copy Markdown
Contributor

@ludfjig ludfjig commented Apr 2, 2026

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 scaffold PR is still not merged so shouldn't merge this until that is merged (and released).

Rendered

@ludfjig ludfjig added area/documentation Related to documentation kind/documentation labels Apr 2, 2026
@syntactically
Copy link
Copy Markdown
Member

Removes the scary sounding Note

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.

@ludfjig ludfjig force-pushed the fix_readme branch 2 times, most recently from dd5297e to 86d63de Compare May 27, 2026 22:05
@ludfjig
Copy link
Copy Markdown
Contributor Author

ludfjig commented May 27, 2026

Removes the scary sounding Note

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.

Added back another version of it

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.md with a shorter overview, examples, repository table, and community/project links.
  • Adds docs/getting-started.md for 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.

Comment thread docs/getting-started.md
Comment thread docs/getting-started.md
Comment thread docs/how-to-build-a-hyperlight-guest-binary.md
Comment thread docs/how-to-build-a-hyperlight-guest-binary.md Outdated
Signed-off-by: Ludvig Liljenberg <4257730+ludfjig@users.noreply.github.com>
@ludfjig
Copy link
Copy Markdown
Contributor Author

ludfjig commented May 28, 2026

This is now ready since https://github.com/hyperlight-dev/cargo-hyperlight/releases/tag/v0.1.11 was released!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants