-
Notifications
You must be signed in to change notification settings - Fork 247
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Refresh readme * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * moving widgets to its own section
- Loading branch information
Showing
3 changed files
with
44 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,83 +1,100 @@ | ||
| # Windows App SDK Samples | ||
| <p align="center"> | ||
| <a href="https://aka.ms/winappsdk"> | ||
| <img src="./docs/images/header.png" alt="Windows App SDK Banner" /> | ||
| </a> | ||
| </p> | ||
|
|
||
| This repository hosts samples for the [Windows App SDK](https://github.com/microsoft/WindowsAppSDK). Samples for various features shipping in the Windows App SDK will be added to this repository. For more information about the Windows App SDK, visit the [Windows App SDK Documentation](https://docs.microsoft.com/windows/apps/windows-app-sdk/). To learn more about the Windows App SDK design or to contribute to the project, make feature proposals, or start discussions, visit the [Windows App SDK GitHub page](https://github.com/microsoft/WindowsAppSDK). | ||
| <h1 align="center">Windows App SDK samples</h1> | ||
|
|
||
| ## List of samples | ||
|
|
||
| #### App Lifecycle and System Services | ||
| This repository hosts samples for the [Windows App SDK](https://github.com/microsoft/WindowsAppSDK). Samples for various features shipping in the Windows App SDK will be added to this repository. For more information about the Windows App SDK, visit the [Windows App SDK documentation](https://docs.microsoft.com/windows/apps/windows-app-sdk/). To learn more about the Windows App SDK design or to contribute to the project, make feature proposals, or start discussions, visit the [Windows App SDK GitHub page](https://github.com/microsoft/WindowsAppSDK). | ||
|
|
||
| ## 💻 List of samples | ||
|
|
||
| ### Artificial Intelligence | ||
| - [Windows Copilot Runtime](Samples/WindowsCopilotRuntime/): These samples demonstrate how to use the [Windows Copilot Runtime APIs](https://learn.microsoft.com/windows/ai/apis/), like Phi Silica, Text Extraction (OCR) and Imaging APIs. | ||
| - [AI Dev Gallery](https://github.com/microsoft/ai-dev-gallery): The AI Dev Gallery is a collection of open-source samples showcasing how to integrate on-device AI capabilities into Windows apps using Windows Copilot Runtime and open-source models using ONNX. | ||
|
|
||
| ### App Lifecycle and System Services | ||
| - [App Lifecycle](Samples/AppLifecycle): These samples demonstrate app instancing using the AppLifecycle APIs. They include the following features: | ||
| - [Activation](Samples/AppLifecycle/Activation): These samples demonstrate support for rich activation kinds. | ||
| - [Instancing](Samples/AppLifecycle/Instancing): These samples demonstrate support for single and selective multi-instancing. | ||
| - [Power Notifications](Samples/AppLifecycle/StateNotifications): These samples demonstrate the power/system state notifications for managing app workload. | ||
| - [Restart](Samples/AppLifecycle/Restart): These samples demonstrate synchronously restarting an app with command-line restart arguments. | ||
| - [Share Target](Samples\AppLifecycle\ShareTarget\WinUI-CS-ShareTargetSampleApp): This sample demonstrates an app that can be activated as a share target. | ||
|
|
||
| #### Data and Files | ||
| ### Data and Files | ||
| - [Resource Management](Samples/ResourceManagement): These samples demonstrates app resource management using the MRT Core APIs. | ||
|
|
||
| #### Deployment | ||
| ### Deployment | ||
| - [Deployment Manager](Samples/DeploymentManager): This sample demonstrates how to initialize and access deployment information for the Windows App SDK runtime. | ||
| - [Installer](Samples/Installer): This sample demonstrates how to launch the Windows App SDK installer without a console window. | ||
| - [Unpackaged](Samples/Unpackaged): These samples demonstrate auto-initialization with the Windows App SDK package from non-MSIX (unpackaged) application. | ||
|
|
||
| #### Dynamic Dependencies | ||
| ### Dynamic Dependencies | ||
| - [DirectX](DynamicDependenciesSample/DynamicDependencies): This sample demonstrates how to use the Dynamic Dependencies API to dynamically load the DirectX Runtime MSIX framework package. | ||
|
|
||
| #### Graphics | ||
| ### Graphics | ||
| - [Mica](Samples/Mica): These samples demonstrate how to use the Mica material in different apps and frameworks. | ||
| - [Text Rendering](Samples/TextRendering): This sample is a gallery of the DWriteCore APIs demonstrating text rendering. | ||
|
|
||
| #### Notifications | ||
| ### Islands | ||
| - [Islands](Samples/Islands): This sample shows how to add a WinAppSDK island with Xaml content to a Win32 app. | ||
|
|
||
| ### Notifications | ||
| - [Push Notifications](Samples/Notifications/Push): This is a sample app that showcases Push Notifications. | ||
| - [App Notifications](Samples/Notifications/App): This is a sample app that showcases App Notifications. | ||
|
|
||
| #### Runtime Components | ||
| ### Runtime Components | ||
| - [Custom Controls](Samples/CustomControls): This sample shows how to author a Windows Runtime Component in C# with custom WinUI controls. | ||
|
|
||
| #### User Interface and Input | ||
| ### User Interface and Input | ||
|
|
||
| - [Windowing](Samples/Windowing): This sample demonstrates how to manage app windows using the Windowing APIs. | ||
| - [Windows Input and Composition Gallery](https://github.com/microsoft/WindowsCompositionSamples): This collection of samples showcases Microsoft.UI.Composition and Microsoft.UI.Input APIs. | ||
| - [WinUI 3 Gallery](https://github.com/microsoft/WinUI-Gallery/): This is a sample app that showcases all of the WinUI 3 controls in action. | ||
| - [Windows Composition, Input and SceneGraph](Samples/SceneGraph): This collection of samples showcases Microsoft.UI.Composition, Microsoft.UI.Input and SceneGraph APIs. | ||
| - [WinUI 3 Gallery](https://github.com/microsoft/WinUI-Gallery): This is a sample app that showcases all of the WinUI 3 controls in action. | ||
|
|
||
| ### Widgets | ||
| - [Widgets](Samples/Widgets): These samples demonstrate how to author Windows Widgets with the Windows App SDK. | ||
|
|
||
| ## Requirements | ||
| ## 💻 Requirements | ||
|
|
||
| Thes Windows App SDK samples have the following system requirements: | ||
|
|
||
| - Windows 10, version 1809 (build 17763) or later. | ||
|
|
||
| - [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/) or Visual Studio 2019 version 16.9 or later, with the following workloads and components: | ||
|
|
||
| - Universal Windows Platform development | ||
| - Windows application development | ||
| - .NET Desktop Development (needed even if you're only building C++ Win32 apps) | ||
| - Desktop development with C++ (needed even if you're only building .NET apps) | ||
| - Windows SDK version 2004 (build 19041) or later. This is installed with Visual Studio by default. | ||
|
|
||
| - Building .NET C# samples with Windows App SDK 1.1 also requires one of the following .NET SDK versions or later: | ||
| - 6.0.202 | ||
| - 6.0.104 | ||
| - 5.0.407 | ||
| - 5.0.213 | ||
|
|
||
| Refer to the docs on [system requirements](https://docs.microsoft.com/windows/apps/windows-app-sdk/system-requirements) and [tools for Windows app development](https://docs.microsoft.com/windows/apps/windows-app-sdk/set-up-your-development-environment) for a detalied list of requirements for developing apps with the Windows App SDK. | ||
|
|
||
| ## Using the samples | ||
| ## 🚀 Using the samples | ||
|
|
||
| To use the samples with Git, clone the WindowsAppSDK-Samples repository by running `git clone https://github.com/microsoft/WindowsAppSDK-Samples.git` from a command prompt. You can then navigate to the directory of a sample and open the solution file in Visual Studio. | ||
|
|
||
| The easiest way to use these samples without Git is to download the ZIP file. Select *Download ZIP* from the download dropdown, unzip the entire archive and open the samples in Visual Studio. | ||
|
|
||
| ### Samples versioning | ||
| ## 📄 Samples versioning | ||
|
|
||
| The samples will be updated with GA releases of the Windows App SDK. The `main` branch includes the latest samples, which may also include experimental or preview features. Specific release branches are named `release/x.y` and contain samples that reference the corresponding GA version of the Windows App SDK. This repository currently includes the following release branches: | ||
|
|
||
| - [release/experimental](https://github.com/microsoft/WindowsAppSDK-Samples/tree/release/experimental) | ||
| - [release/1.6](https://github.com/microsoft/WindowsAppSDK-Samples/tree/release/1.6-stable) | ||
| - [release/1.5](https://github.com/microsoft/WindowsAppSDK-Samples/tree/release/1.5-stable) | ||
| - [release/1.1](https://github.com/microsoft/WindowsAppSDK-Samples/tree/release/1.1) | ||
| - [release/1.0](https://github.com/microsoft/WindowsAppSDK-Samples/tree/release/1.0) | ||
| - [release/0.8](https://github.com/microsoft/WindowsAppSDK-Samples/tree/release/0.8) | ||
| - [release/0.5](https://github.com/microsoft/WindowsAppSDK-Samples/tree/release/0.5) | ||
|
|
||
| ## Contributing | ||
| ## 🏆 Contributing | ||
|
|
||
| These samples are provided by feature teams and we welcome your input on issues and suggestions for new samples. We encourage you to [file a new issue](https://github.com/microsoft/WindowsAppSDK-Samples/issues/new) for any feedback or questions! | ||
|
|
||
| Sample authors should follow the [samples guidelines](docs/samples-guidelines.md) to begin developing their samples. For WinUI-based Windows App SDK samples, use the [sample templates](Templates/README.md). The VSIX file is available for download in the Github releases page [here](https://github.com/microsoft/WindowsAppSDK-Samples/releases). | ||
| Sample authors should follow the [samples guidelines](docs/samples-guidelines.md) to begin developing their samples. For WinUI-based Windows App SDK samples, use the [sample templates](Templates/README.md). The VSIX file is available for download in the GitHub releases page [here](https://github.com/microsoft/WindowsAppSDK-Samples/releases). | ||
|
|
||
| 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 or contact [email protected] with any additional questions or comments. | ||
|
|
||
|
|
||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters