microsoft/openvmm
Publicmirrored from https://github.com/microsoft/openvmmAvailable
Guide/src/dev_guide/getting_started/windows.md
73lines · modecode
| 1 | # Getting started on Windows |
| 2 | |
| 3 | This page provides instructions for installing the necessary dependencies to |
| 4 | build OpenVMM on Windows. |
| 5 | |
| 6 | ```admonish tip |
| 7 | We _strongly_ suggest using [WSL2](./linux.md) for OpenVMM development, rather |
| 8 | than developing on Windows directly. |
| 9 | |
| 10 | Developing in WSL2 offers a smoother development experience, while still |
| 11 | allowing you to build and run OpenVMM on Windows through the use of |
| 12 | [cross compilation](./suggested_dev_env.md#wsl2-cross-compiling-from-wsl2-to-windows). |
| 13 | |
| 14 | Additionally, it allows you to have a single clone of the OpenVMM repo |
| 15 | suitable for both OpenVMM and OpenHCL development. |
| 16 | ``` |
| 17 | |
| 18 | You must be running a recent version of Windows 11. Windows 10 is no longer |
| 19 | supported as a development platform, due to needed WHP APIs. |
| 20 | |
| 21 | **NOTE: OpenHCL does NOT build on Windows.** |
| 22 | |
| 23 | If you are interested in building OpenHCL, please follow the getting started |
| 24 | guide for [Linux / WSL2](./linux.md). |
| 25 | |
| 26 | ## Installing Rust |
| 27 | |
| 28 | To build OpenVMM, you first need to install Rust. |
| 29 | |
| 30 | The OpenVMM project actively tracks the latest stable release of Rust, though it |
| 31 | may take a week or two after a new stable is released until OpenVMM switches |
| 32 | over to it. |
| 33 | |
| 34 | Please follow the [official instructions](https://www.rust-lang.org/tools/install) to do so. |
| 35 | |
| 36 | If you don't already have it, you will need to install |
| 37 | [Visual Studio C++ Build tools ](https://visualstudio.microsoft.com/visual-cpp-build-tools/) |
| 38 | or [Visual Studio](https://visualstudio.microsoft.com/vs/) with the component |
| 39 | "Desktop Development for C++". |
| 40 | |
| 41 | This can be installed via `Visual Studio Installer` -> `Modify` -> `Individual Components` |
| 42 | -> `MSVC v143 - VS 2022 C++ x64/x86 build tools (latest)`. |
| 43 | |
| 44 | Or, you can install the tool via the powershell command below. |
| 45 | |
| 46 | ```powershell |
| 47 | PS> winget install Microsoft.VisualStudio.2022.Community --override "--quiet --add Microsoft.VisualStudio.Component.VC.Tools.x86.x64" |
| 48 | ``` |
| 49 | |
| 50 | ### Aarch64 support |
| 51 | |
| 52 | To build ARM64, you need an additional dependency. |
| 53 | This can be installed via `Visual Studio Installer` -> `Modify` -> `Individual Components` |
| 54 | -> `MSVC v143 - VS 2022 C++ ARM64/ARM64EC build tools (latest)`. |
| 55 | |
| 56 | Or, you can install the tool via the powershell command below. |
| 57 | |
| 58 | ```powershell |
| 59 | PS> winget install Microsoft.VisualStudio.2022.Community --override "--quiet --add Microsoft.VisualStudio.Component.VC.Tools.ARM64" |
| 60 | ``` |
| 61 | |
| 62 | ## Cloning the OpenVMM source |
| 63 | |
| 64 | If you haven't already installed `git`, you can download it |
| 65 | [here](https://git-scm.com/downloads). |
| 66 | |
| 67 | ```powershell |
| 68 | PS> git clone https://github.com/microsoft/openvmm.git |
| 69 | ``` |
| 70 | |
| 71 | ## Next Steps |
| 72 | |
| 73 | You are now ready to build [OpenVMM](./build_openvmm.md)! |