docs: improve guest creation documentation#1254
docs: improve guest creation documentation#1254jsturtevant wants to merge 2 commits intohyperlight-dev:mainfrom
Conversation
Add a few more directions to readme and add some trouble shooting. Signed-off-by: James Sturtevant <jsturtevant@gmail.com>
jsturtevant
requested review from
danbugs,
dblnz,
devigned,
jprendes,
ludfjig,
marosset,
simongdavies and
syntactically
as code owners
| #![no_std] | ||
| #![no_main] | ||
| extern crate alloc; | ||
| extern crate hyperlight_guest_bin; |
There was a problem hiding this comment.
Is this really needed? The simpleguest doesn't do this, it does it for hyperlight_guest though 🤔
There was a problem hiding this comment.
I think it's necessary when the crate doesn't use any other hyperlight_guest_bin features
There was a problem hiding this comment.
yea i think that is what we found out here: #1175 (comment)
There was a problem hiding this comment.
LGTM. What do you think about adding a minimal (weekly?) test that tries to compile a minimal guest like the one I posted in #1175 using cargo-hyperlight? Maybe we can also link to it from the docs to show what a minimal guest looks like. I think it could be useful, and by making it weekly, we don't slow down existing stuff like just guests
Yea, maybe using the code from the readme would be a good thing since it isn't currently tested as is |
3 participants
Add a few more directions to readme and add some trouble shooting.
addresses #1191