microsoft/openvmm

Public

mirrored from https://github.com/microsoft/openvmmAvailable

CodeCommitsIssuesPull requestsActionsInsightsSecurity
f04cd4aa22bccbc47d27ddc5a95197bf88d3b54a

Branches

Tags

  • No tags available.
0Branches0Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

Guide/src/dev_guide/getting_started/windows.md

70lines · modecode

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