Quick Start

Prerequisites

Install Visual Studio

Install Visual Studio 2022 and up.

Install Visual Studio deps

1. Run "Visual Studio Installer"
2. Select "Modify" on visual studio "Visual Studio"
3. Check ".NET desktop development"
4. Check "Universal Windows Platform development"
5. Under "Installation details/Universal Windows Platform development"
   1. Check the the "Windows 10 SDK (10.0.19041.0)" is checked

Install SDKs

1. Download and install .NET 8 if you don't have it.
2. If you are building cross platform, run uno-check to ensure you have the correct workloads installed.

Optional

• XAML Styler VS Extension: formats XAML source code based on a set of styling rules.

Clone Repo

Warning: Try not to clone the repo into any location where the path is already significantly long. There is a windows an existing MAX path issue with windows (Files on paths longer than 256 cannot be found be the build tool chain). Within the project there are paths of 190 characters, so the shorter the base directory the better.

git clone --recurse-submodules https://github.com/CommunityToolkit/Windows.git

Generate solution

Ensure that MSBuild is on your PATH, then run GenerateAllSolution.bat from the root directory. When solution generation is complete, Visual Studio will open automatically with the solution loaded.

Build and go

With the desired platform selected as the startup project, you're ready to build components and samples, run tests, or build and deploy the gallery app for the Community Toolkit.