Quick Start

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

Building the entire 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.

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.

Building a specific component

1. Navigate to a specific component, e.g. ..\Windows\components\SettingsControls
2. Run OpenSolution.bat to generate the solution and project heads
3. Open the solution (e.g. SettingsControls.sln
4. In Visual Studio, select your preferred project head (UWP, WinAppSDK or WASM) and hit F5: