diff --git a/README.md b/README.md index 6e7e8f9b71..c31a1c7a9b 100644 --- a/README.md +++ b/README.md @@ -26,8 +26,7 @@ WinUI is a user interface layer that contains modern controls and styles for bui - **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.

-Powers key experiences in Windows -
+ Powers key experiences in Windows

## 📋 Getting started with WinUI @@ -38,8 +37,8 @@ The full documentation of WinUI can be found on [Microsoft Learn](https://learn. - [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/how-tos/hello-world-winui3) - [WinUI & Windows App SDK samples](https://github.com/microsoft/WindowsAppSDK-Samples) - -
+- [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 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. @@ -48,37 +47,30 @@ Make sure to also check out the [WinUI 3 Gallery](https://aka.ms/winui-gallery), WinUI 3 Gallery

- - - + + + + +

-
## 📺 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/contribution_handling.md) guidelines. For information on how to contribute, please see [Contributing to WinUI](CONTRIBUTING.md). -
- ## 🛣️ Roadmap For info on the WinUI release schedule and high level plans please see the [WinUI roadmap](https://aka.ms/winappsdk/plans). -
- ## 🔧 WinUI 2 (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 2 [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 diff --git a/docs/SECURITY.md b/docs/SECURITY.md deleted file mode 100644 index 34875abfa1..0000000000 --- a/docs/SECURITY.md +++ /dev/null @@ -1,41 +0,0 @@ - - -# Security - -Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [many more](https://opensource.microsoft.com/). - -If you believe you have found a security vulnerability in any Microsoft-owned repository that meets Microsoft's [definition](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)) of a security vulnerability, please report it to us as described below. - -## Reporting Security Issues - -**Please do not report security vulnerabilities through public GitHub issues.** - -Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report). - -If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc). - -You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). - -Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: - -* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) -* Full paths of source file(s) related to the manifestation of the issue -* The location of the affected source code (tag/branch/commit or direct URL) -* Any special configuration required to reproduce the issue -* Step-by-step instructions to reproduce the issue -* Proof-of-concept or exploit code (if possible) -* Impact of the issue, including how an attacker might exploit the issue - -This information will help us triage your report more quickly. - -If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://microsoft.com/msrc/bounty) page for more details about our active programs. - -## Preferred Languages - -We prefer all communications to be in English. - -## Policy - -Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd). - - diff --git a/docs/images/StoreBadge-dark.png b/docs/images/StoreBadge-dark.png new file mode 100644 index 0000000000..8095159a82 Binary files /dev/null and b/docs/images/StoreBadge-dark.png differ diff --git a/docs/images/StoreBadge-light.png b/docs/images/StoreBadge-light.png new file mode 100644 index 0000000000..fc4c9aa8eb Binary files /dev/null and b/docs/images/StoreBadge-light.png differ diff --git a/docs/images/storeBadge.png b/docs/images/storeBadge.png deleted file mode 100644 index 4d78d31495..0000000000 Binary files a/docs/images/storeBadge.png and /dev/null differ diff --git a/docs/roadmap.md b/docs/roadmap.md deleted file mode 100644 index 52e449c149..0000000000 --- a/docs/roadmap.md +++ /dev/null @@ -1,67 +0,0 @@ -# Windows UI Library Overview - -WinUI is the modern native UI platform for Windows with two active generations: - -1. **WinUI 3**: The latest, 3rd generation of WinUI that ships the entire WinUI stack decoupled from the operating system as a part of the [Windows App SDK](https://docs.microsoft.com/windows/apps/windows-app-sdk/). - -2. **WinUI 2**: The previous generation of the WinUI stack for UWP apps, consisting of a XAML and Visual Layer built directly into the Windows 10 operating system, and a controls library built on top of the OS, delivered via NuGet, and hosted at this repository. WinUI 2 will continue to be supported with bug, reliability, and security fixes. - -**For a detailed look on the difference between WinUI 2 & 3, please view our [comparison table](https://docs.microsoft.com/windows/apps/winui/#comparison-of-winui-3-and-winui-2) - -### Benefits of WinUI - -WinUI provides a number of benefits which makes it the best way to create user interfaces for Windows apps: - -1. **The native UI platform of Windows** -WinUI is the highly-optimized native UI platform used to create Windows itself, now made more broadly available for all developers to use to reach Windows. It's a thoroughly tested and proven UI platform that powers the operating system environment and essential experiences of 1 billion+ Windows 10 & 11 PC, XBox One, HoloLens, Surface Hub and other devices. - -2. **The latest advancements in Fluent Design** -WinUI is Microsoft's main focus for native, accessible Windows UI and controls and is the definitive source for the [Fluent Design System](https://www.microsoft.com/design/fluent/) on Windows. -It will also support the latest composition and rendering innovations like vector animations, effects, shadows and lighting. - -3. **Backward compatibility for new features** -New WinUI features will continue to be backward-compatible with a wide range of Windows 10 and 11 versions. With WinUI 3, you can start building and shipping apps with new features immediately as soon as they're released, without having to wait for your users to be running the latest update of Windows. - -4. **Native development support** -WinUI can be used with .NET, but doesn't depend on .NET: WinUI is 100% C++ and can be used in unmanaged Windows apps, for example using standard C++17 via [C++/WinRT](https://docs.microsoft.com/windows/uwp/cpp-and-winrt-apis/). - -5. **More frequent updates** -WinUI is planned to ship roughly every 6 months, with at least two preview builds per stable release. This is more of a guideline than a rule, but that is what the team strives for. - -6. **Open source development and community engagement** - The WinUI 2 Controls Library is already open source on GitHub, and we're planning to add the full WinUI 3 framework into this repo as well. You can engage directly with Microsoft's core engineering team and contribute bug reports, feature ideas, and even code: see the [Contribution Guide](../CONTRIBUTING.md) for more info. You can also try out the pre-release builds to see new in-development features and help shape their final form. - -## WinUI 3 - -**[WinUI 3](https://docs.microsoft.com/windows/apps/winui/winui3/)** is the latest generation of native Windows UI, consisting of all the major UX layers of Windows decoupled and shipping as a standalone solution for you to use. - -It focuses on enabling three main use cases: - -1. **Modernizing existing apps** - * Enabling you to extend existing Win32 (WPF, WinForms, MFC...) apps with modern Windows UI at your own pace using the upcoming release of [Xaml Islands](https://docs.microsoft.com/windows/apps/desktop/modernize/xaml-islands). Developers who currently use WinUI 2 for their app UX will be able to easily move to WinUI 3, as their syntax and capabilities are very similar -2. **Creating new Windows apps** - * Enabling you to easily create new modern Windows apps with the flexibility offered by the [Windows App SDK](https://docs.microsoft.com/windows/apps/windows-app-sdk/) -3. **Enabling other frameworks** - * Providing the native implementation for other frameworks like [React Native](https://github.com/Microsoft/react-native-windows) and .NET [MAUI](https://docs.microsoft.com/dotnet/maui/what-is-maui) when running on Windows. - -WinUI 3 is available as a part of the [Windows App SDK](https://docs.microsoft.com/windows/apps/windows-app-sdk) for building stable and supported desktop/Win32 apps for production scenarios. You can download and read more about the latest releases of the Windows App SDK at the following documentation. - -[Stable release channel for the Windows App SDK](https://docs.microsoft.com/windows/apps/windows-app-sdk/stable-channel) - -We also ship experimental features as we develop them. You can read more about the Windows App SDK Experimental releases at the following documentation. Note that Experimental releases have limitations and known issues, so they are not equipped for production apps. - -[Experimental release channel for the Windows App SDK](https://docs.microsoft.com/windows/apps/windows-app-sdk/experimental-channel). - -### Roadmap - -For more info about upcoming features in the next release of WinUI 3, see the [Windows App SDK feature roadmap](https://github.com/microsoft/WindowsAppSDK/blob/main/docs/roadmap.md). - -## WinUI 2 Controls Library - -WinUI 2 is a native user experience (UX) framework for both Windows desktop and UWP applications tightly integrated with Windows 10 and above SDKs. - -The latest release of the **WinUI 2 Controls Library** was v2.8 which was released in July 2022. You can find a list of what was introduced in this release in the [release notes](https://learn.microsoft.com/en-us/windows/apps/winui/winui2/release-notes/winui-2.8). - -At this time, there are no plans for a WinUI 2.9. However, WinUI 2 will continue to be supported through servicing releases with bug, reliability, and security fixes as needed. - -For installation instructions see [Getting started with the Windows UI Library](https://docs.microsoft.com/windows/apps/winui/winui2/getting-started). diff --git a/docs/winrt-apis-for-desktop.md b/docs/winrt-apis-for-desktop.md deleted file mode 100644 index a94c13ae13..0000000000 --- a/docs/winrt-apis-for-desktop.md +++ /dev/null @@ -1,5 +0,0 @@ -# WinRT API changes for Desktop apps - -The content from this doc has been moved to our official documentation site, and will continue to be maintained there. - -You can find the updated doc at: [Windows Runtime APIs not supported in Desktop apps](https://docs.microsoft.com/windows/apps/desktop/modernize/desktop-to-uwp-supported-api). \ No newline at end of file diff --git a/docs/winui3_migration.md b/docs/winui3_migration.md deleted file mode 100644 index 1575390599..0000000000 --- a/docs/winui3_migration.md +++ /dev/null @@ -1,22 +0,0 @@ -# Migrating a UWP App To WinUI3 - -**It is recommended to use the [try-convert](https://github.com/dotnet/try-convert/tree/feature/winui) tool for the full conversion process.** -**`try-convert` will automate most of the conversion steps.** - -## Background - -The purpose of the [try-convert WinUI3 feature](https://github.com/dotnet/try-convert/tree/feature/winui) is to create a porting solution to allow developers to convert WinUI2 projects to the new WinUI3 format. - -- WinUI is a native user experience (UX) framework for both Windows Desktop and UWP applications. WinUI ships as part of the Windows OS. -[More on WinUI](http://aka.ms/winui), [Docs](https://docs.microsoft.com/en-us/windows/apps/winui) -- WinUI3 is the next version of WinUI. It runs on the native Windows 10 UI platform and supports both Windows Desktop and UWP apps. WinUI3 ships as a NuGet package. -[More on WinUI3](https://docs.microsoft.com/en-us/windows/apps/winui/winui3) - -Converting an existing WinUI C# App to WinUI3 requires some changes to the C# source code. Most notably namespace changes from Windows.UI.* to Microsoft.UI.* - -This porting assistance is provided in the form of Roslyn Analyzers and Code Fixes. -- A Code Analyzer provides on the fly code inspections for C# and creates diagnostics. -- A Code Fix consumes the diagnostics created by the Code Analyzer and modifies the C# file in-line. - -See the [try-convert documentation](https://github.com/dotnet/try-convert/tree/feature/winui) for more information on these code analyzers and how to automoate the process with [try-convert](https://github.com/dotnet/try-convert/blob/feature/winui/WinUIConvert.md). -