hermit-os / uhyve

A specialized hypervisor for Hermit.
Apache License 2.0
254 stars 29 forks source link

README: Make it more beginner-friendly #714

Closed n0toose closed 2 months ago

n0toose commented 3 months ago

In the beginning, I found myself quite lost as I was not totally sure how to use Uhyve. This change introduces some additional background information and pointers for people looking to hack on the source code.

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 68.17%. Comparing base (e6ffffa) to head (2349887). Report is 6 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #714 +/- ## ======================================= Coverage 68.17% 68.17% ======================================= Files 20 20 Lines 2319 2319 ======================================= Hits 1581 1581 Misses 738 738 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

n0toose commented 3 months ago

I addressed the review comments and made some additional changes to make them "fit" well, such as adding clearer headers and separating the content better - this introduces some new changes without changing the substance.

Perhaps it would be better if a CONTRIBUTING.md file were to be written in the future instead of cramming everything in the README file, but it should be adequate enough for now.

jounathaen commented 3 months ago

Oh, and I'd stash these changes into a single commit...

n0toose commented 3 months ago

Wait, one more rebase!