diff --git a/README.md b/README.md index bc59b6aee..7dcd0bac8 100644 --- a/README.md +++ b/README.md @@ -78,3 +78,5 @@ python scripts\nvx.py run - [Package and source delivery](doc/distribution.md) - Instructions for packaging and distributing NVX. - [Contributing](doc/contribute.md) - Guidelines for contributing to NVX. +- [OpenVMM upstream roadmap](doc/openvmm-upstream-roadmap.md) - Plan for upstreaming the OpenVMM + fork's microVM commits. diff --git a/doc/contribute.md b/doc/contribute.md index 278316fe6..e7b27cb60 100644 --- a/doc/contribute.md +++ b/doc/contribute.md @@ -126,6 +126,12 @@ Change OpenVMM through a pull request to `nanvix/openvmm` that follows including their Clippy, rustdoc, test, and formatting checks, then promote the reviewed revision into NVX. +`nanvix/openvmm` is a fork of +[microsoft/openvmm](https://github.com/microsoft/openvmm). The +[OpenVMM upstream roadmap](openvmm-upstream-roadmap.md) groups the fork's +microVM commits into planned upstream pull requests and marks those that stay +fork-only. + ### Pin promotion A pin promotion moves the `openvmm` gitlink to a reviewed OpenVMM revision: