## 1. Project Overview & Quickstart (microsoft/microsoft-ui-xaml)
## File: README.md
WinUI
[About WinUI](https://learn.microsoft.com/windows/apps/winui/winui3/)
ยท
[Documentation](https://learn.microsoft.com/windows/apps/)
ยท
[Release notes](https://aka.ms/winui-releasenotes)
WinUI is a user interface layer that contains modern controls and styles for building Windows apps. The current generation is WinUI 3, which ships as part of the [Windows App SDK](https://learn.microsoft.com/windows/apps/windows-app-sdk/).
- **Modern UI:** WinUI embodies Fluent Design to enable intuitive, accessible, and powerful experiences and the latest user interface patterns.
- **Developers in control:** Use .NET with C# or C++ to write apps that run great on x86, x64 and ARM.
- **Optimized for modern experiences & hardware:** Create performant experiences with WinUI that are optimized for modern hardware.
- **Part of the Windows App SDK:** The [Windows App SDK](https://learn.microsoft.com/windows/apps/windows-app-sdk/) is a set of libraries, frameworks, components, and tools that you can use in your apps to access powerful Windows platform functionality from all kinds of apps on many versions of Windows. The Windows App SDK combines the powers of Win32 native applications alongside modern API usage techniques, so your apps light up everywhere your users are.
- **Powers key experiences in Windows:** Windows experiences and apps are built with WinUI. Its rich control set and styles make it easy to develop high-quality experiences used by millions every day.
## ๐ Getting started with WinUI
For WinUI, your app's users must be on Windows 10 1809 - Build 17763 or newer (including Windows Insider Previews).
The full documentation of WinUI can be found on [Microsoft Learn](https://learn.microsoft.com/windows/apps/):
- [Get started with WinUI](https://learn.microsoft.com/windows/apps/get-started/start-here)
- [Build your first WinUI app](https://learn.microsoft.com/windows/apps/tutorials/winui-notes/)
- [Migrate from UWP to the Windows App SDK](https://learn.microsoft.com/windows/apps/windows-app-sdk/migrate-to-windows-app-sdk/migrate-to-windows-app-sdk-ovw)
- [Windows Runtime APIs not supported in desktop apps](https://learn.microsoft.com/windows/apps/desktop/modernize/desktop-to-uwp-supported-api)
- [WinUI & Windows App SDK samples](https://learn.microsoft.com/windows/apps/get-started/samples)
## ๐ผ๏ธ WinUI 3 Gallery
Make sure to also check out the [WinUI 3 Gallery](https://aka.ms/winui-gallery), our interactive sample experience showing everything you can do with WinUI.
## ๐บ WinUI Community Call
The WinUI Community Call is your opportunity to learn about WinUI and to engage with the WinUI team and community. Join us online on YouTube at the [Windows Developer channel](https://www.youtube.com/playlist?list=PLI_J2v67C23ZqsolUDaHoFkF1GKvGrttB).
## ๐ข Contributing to WinUI
The WinUI team welcomes your feedback! To understand how we handle incoming feature requests and bugs, please see our [contribution handling](docs/external/contribution_handling.md) guidelines.
For information on how to contribute, please see [Contributing to WinUI](CONTRIBUTING.md).
> [!WARNING]
> We're not yet ready to accept code contributions, but we are working towards that goal. It is now
> possible to build the WinUI product binaries, with work in progress to share test code and enabling
> locally running tests. To get started building WinUI from source and see more details on current
> limitations, see [Getting started with building WinUI](GettingStarted.md). See the
> [WinUI OSS Update post](https://github.com/microsoft/microsoft-ui-xaml/discussions/10700) to check the
> latest status.
>
> For the latest code and updates, use the [`winui3/main`](https://github.com/microsoft/microsoft-ui-xaml/tree/winui3/main) branch.
## ๐ฃ๏ธ Roadmap
For info on the WinUI release schedule and high level plans please see the [WinUI roadmap](https://aka.ms/winappsdk/plans).
## ๐ง WinUI for UWP
WinUI for UWP (WinUI 2) is a library of controls that provides Microsoft UI controls and features for [UWP apps](https://docs.microsoft.com/windows/uwp/index). Learn more about WinUI for UWP [here](https://aka.ms/winui2) or download the source code [here](https://github.com/microsoft/microsoft-ui-xaml/tree/winui2/main).
You can get the WinUI 2 Gallery [on the Microsoft Store](https://www.microsoft.com/store/productId/9MSVH128X2ZT?ocid=pdpshare) and see the source code [here](https://github.com/microsoft/WinUI-Gallery/tree/winui2).
### Data/Telemetry
This project collects usage data and sends it to Microsoft to help improve our products and services. Note, however, that no data collection is performed when using your private builds.
### Code of Conduct
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
---
## File: docs/README.md
# WinUI Developer Documentation
Welcome! This directory contains documentation for those developers working in the WinUI repository.
Note that developer usage documentation can be found separately on docs.microsoft.com.
## Table of Contents
- [Getting Started](#getting-started)
- [Repo Layout](#repo-layout)
- [Developer Guide](#developer-guide)
- [WinUI Test System](#winui-test-system)
- [Build System How-To](#build-system-how-to)
- [Windows App SDK](#windows-app-sdk)
- [Design docs](#design-docs)
## Getting Started
### Repo Layout
To get an understanding of how the repository is laid out, see the [repo structure](repo-structure.md) doc.
### Developer Guide
The [developer guide](./building/developer-guide.md) contains information on how to do the day-to-day tasks in this repo, as well as the tools and setup required to get going.
### WinUI Test System
See [Testing In WinUI FAQ](./testing/testing-FAQ.md) and [WinUI CI Test System Overview](./testing/test-system-overview.md) for information on how to run our test automation.
### Build System How-To
For more detailed information on how to accomplish common tasks with the build system, see the [build system how-to doc](./building/build-system-howto.md) to help you accomplish your tasks
### Windows App SDK
See [Windows App SDK Overview](winappsdk-overview.md) for an overview of WinUI 3 integration into the Windows App SDK.
## Design docs
* [Build system](./building/build-system-design.md)
>Problem? Please file an issue for help.
>
>Found a bug? Please file an issue at [our issue tracker](https://github.com/microsoft/microsoft-ui-xaml/issues) and we'll triage it.
---
## File: docs/Readme.md
# WinUI Developer Documentation
Welcome! This directory contains documentation for those developers working in the WinUI repository.
Note that developer usage documentation can be found separately on docs.microsoft.com.
## Table of Contents
- [Getting Started](#getting-started)
- [Repo Layout](#repo-layout)
- [Developer Guide](#developer-guide)
- [WinUI Test System](#winui-test-system)
- [Build System How-To](#build-system-how-to)
- [Windows App SDK](#windows-app-sdk)
- [Design docs](#design-docs)
## Getting Started
### Repo Layout
To get an understanding of how the repository is laid out, see the [repo structure](repo-structure.md) doc.
### Developer Guide
The [developer guide](./building/developer-guide.md) contains information on how to do the day-to-day tasks in this repo, as well as the tools and setup required to get going.
### WinUI Test System
See [Testing In WinUI FAQ](./testing/testing-FAQ.md) and [WinUI CI Test System Overview](./testing/test-system-overview.md) for information on how to run our test automation.
### Build System How-To
For more detailed information on how to accomplish common tasks with the build system, see the [build system how-to doc](./building/build-system-howto.md) to help you accomplish your tasks
### Windows App SDK
See [Windows App SDK Overview](winappsdk-overview.md) for an overview of WinUI 3 integration into the Windows App SDK.
## Design docs
* [Build system](./building/build-system-design.md)
>Problem? Please file an issue for help.
>
>Found a bug? Please file an issue at [our issue tracker](https://github.com/microsoft/microsoft-ui-xaml/issues) and we'll triage it.
---
## File: docs/readme.md
# WinUI Developer Documentation
Welcome! This directory contains documentation for those developers working in the WinUI repository.
Note that developer usage documentation can be found separately on docs.microsoft.com.
## Table of Contents
- [Getting Started](#getting-started)
- [Repo Layout](#repo-layout)
- [Developer Guide](#developer-guide)
- [WinUI Test System](#winui-test-system)
- [Build System How-To](#build-system-how-to)
- [Windows App SDK](#windows-app-sdk)
- [Design docs](#design-docs)
## Getting Started
### Repo Layout
To get an understanding of how the repository is laid out, see the [repo structure](repo-structure.md) doc.
### Developer Guide
The [developer guide](./building/developer-guide.md) contains information on how to do the day-to-day tasks in this repo, as well as the tools and setup required to get going.
### WinUI Test System
See [Testing In WinUI FAQ](./testing/testing-FAQ.md) and [WinUI CI Test System Overview](./testing/test-system-overview.md) for information on how to run our test automation.
### Build System How-To
For more detailed information on how to accomplish common tasks with the build system, see the [build system how-to doc](./building/build-system-howto.md) to help you accomplish your tasks
### Windows App SDK
See [Windows App SDK Overview](winappsdk-overview.md) for an overview of WinUI 3 integration into the Windows App SDK.
## Design docs
* [Build system](./building/build-system-design.md)
>Problem? Please file an issue for help.
>
>Found a bug? Please file an issue at [our issue tracker](https://github.com/microsoft/microsoft-ui-xaml/issues) and we'll triage it.
## 2. Official Technical Reference & Guides (microsoft/microsoft.github.io)
[microsoft.github.io](https://microsoft.github.io)
===================
Many open source projects released by Microsoft products, services and teams also have
deployments powered by GitHub Pages on this domain.
To discover Microsoft-released open source projects, learn about Microsoft's open source
approach and other information, check us out online at [opensource.microsoft.com](https://opensource.microsoft.com).
If we can help answer questions about the open source program at Microsoft, you can
contact `opensource at microsoft com` - although we are not able to provide support
for projects through this mechanism.
## Microsoft GitHub resources
- Default repo templates including `SECURITY.MD` and code of conduct files: [microsoft/repo-templates](https://github.com/microsoft/repo-templates)
- [Code of Conduct](https://opensource.microsoft.com/codeofconduct) ([FAQ](https://opensource.microsoft.com/codeofconduct/faq/))
## Microsoft open source resources
- [Open Source Blog](https://cloudblogs.microsoft.com/opensource/)
- [The Open Source Show on Channel 9](https://channel9.msdn.com/Shows/The-Open-Source-Show)
- [https://opensource.microsoft.com/](https://opensource.microsoft.com/)
## Resources for Microsoft employees
- [docs.opensource.microsoft.com](https://docs.opensource.microsoft.com)
- [Link your GitHub Account and join GitHub organizations automatically](https://repos.opensource.microsoft.com)
## How to identify an official Microsoft organization on GitHub
- Official Microsoft GitHub orgs have a professional avatar and include a web address at Microsoft.com or an associated official domain
- Official Microsoft orgs are [Verified on GitHub](https://github.blog/changelog/2018-08-07-domain-verification/) - look for the domain verification indicator on GitHub