-
Notifications
You must be signed in to change notification settings - Fork 334
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updated README #4920
Open
0x5bfa
wants to merge
30
commits into
microsoft:main
Choose a base branch
from
0x5bfa:5bfa/GH-ReadMe
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Updated README #4920
Changes from 27 commits
Commits
Show all changes
30 commits
Select commit
Hold shift + click to select a range
c5570f4
Update README.md
0x5bfa 684e3c0
Add a WinUI Gallery screenshot
0x5bfa 8ca614a
Update README.md
0x5bfa 52736d9
Update README.md
0x5bfa a37fe6f
Update roadmap.md
0x5bfa ec170da
Update README.md
0x5bfa 493762a
Reupload
0x5bfa c2c81d1
Update
0x5bfa 5f1f64a
Update
0x5bfa 40ca921
Update README.md
0x5bfa a6d441e
Update README.md
0x5bfa f294f36
Update README.md
0x5bfa 3c78e8a
Update README.md
0x5bfa 9aebc6c
Update README.md
0x5bfa 772437f
Update README.md
0x5bfa 76d1cfd
Update README.md
0x5bfa b134e61
Update README.md
0x5bfa 01bbdce
Update README.md
0x5bfa 0c8d387
Update README.md
0x5bfa a3ed59a
Update README.md
0x5bfa a39f19a
Update README.md
0x5bfa 71f9c16
Update README.md
0x5bfa 3165d3a
Update README.md
0x5bfa f15a9f1
Update README.md
0x5bfa 432dfc4
Update README.md
0x5bfa 4a2b46c
Update README.md
0x5bfa 51ec59d
Update README.md
0x5bfa c3e0576
Update README.md
0x5bfa d7ad9fb
Update README.md
0x5bfa 7174152
Update README.md
0x5bfa File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,90 +1,88 @@ | ||
# Windows App SDK - Calling all Windows developers! | ||
|
||
*Previously known as Project Reunion*. | ||
|
||
| Delight users with modern UI | Access new platform features | Backwards compatible | | ||
|:--:|:--:|:--:| | ||
| <img src="https://docs.microsoft.com/media/illustrations/biztalk-get-started-get-started.svg" width=250 alt="Modern navigation"/><br>Powerful WinUI 3 UI | <img src="https://docs.microsoft.com/media/illustrations/biztalk-get-started-scenarios.svg" width=250 alt="Platform logo"/><br>Localization + power status + more<br> | <img src="https://docs.microsoft.com/media/illustrations/biztalk-host-integration-install-configure.svg" width=250 alt="Down-level logo"/><br>Down to Windows 10 1809 | | ||
|
||
...and more, **without having to rewrite your app!** | ||
|
||
* Use your current installer *(no requirement to use MSIX, but there are [reliability/security benefits to using MSIX](https://docs.microsoft.com/windows/msix/overview#key-features)!)* | ||
* Additive platform APIs *(only add what you need, leave the rest of your app as-is)* | ||
* Works with Win32, WPF, WinForms, and more apps | ||
|
||
Plus, **create beautiful, modern apps for Windows 11 that are backwards compatible** to Windows 10 October 2018 Update (build 17763 / version 1809)! | ||
|
||
### Version support | ||
|
||
The Windows App SDK aims to work on supported versions of Windows. | ||
Right now we support down to build 17763 (version 1809/October 2018 Update) of Windows 10. | ||
Wherever possible, we'll use techniques like '_polyfills_' | ||
and custom implementations to do the | ||
heavy lifting for you and make sure your app works across Windows versions and devices. | ||
In the future, there may be a couple APIs that are dependent on new OS features | ||
(like new Action Center functionality), | ||
however we will do our best to ensure | ||
this is the exception and not the norm, and provide reasonable fallbacks when possible. | ||
|
||
|
||
### Helpful links | ||
|
||
* [More details about the Windows App SDK](https://github.com/microsoft/WindowsAppSDK/blob/master/docs/README.md) - | ||
More on what the project is and how we're approaching the work. | ||
* [Video on Windows App SDK](https://techcommunity.microsoft.com/t5/video-hub/enterprise-development-futures-project-reunion/m-p/2177278) - Learn about the Windows App SDK in a 22 minute video! | ||
* [Contributor guide](docs/contributor-guide.md) - How to contribute to the Windows App SDK. | ||
* [FAQ](docs/faq.md) - Frequently asked questions about the Windows App SDK. | ||
* [Developer docs](https://aka.ms/windowsappsdkdocs) - Microsoft documentation covering a wide range of Windows App SDK topics. | ||
* [Samples](https://github.com/microsoft/WindowsAppSDK-Samples) - Discover Windows App SDK samples to assist in learning how to use the latest features! | ||
|
||
### Contributing | ||
|
||
[![Bugs](https://img.shields.io/github/issues/microsoft/windowsappsdk/bug)](https://github.com/microsoft/WindowsAppSDK/issues?q=is%3Aissue+is%3Aopen+label%3Abug) | ||
|
||
_We want to hear from you!_ | ||
|
||
File a [new issue!](https://github.com/microsoft/WindowsAppSDK/issues/new/choose) Tell us what problem you're | ||
trying to solve, how you've tried to solve it so far, and what would be the ideal solution for your app. Bonus | ||
points if there's a gist or existing repo we can look at with you. | ||
<p align="center"> | ||
<a href="https://aka.ms/winappsdk"> | ||
<img src="./docs/images/header.png" alt="Windows App SDK Banner" /> | ||
</a> | ||
</p> | ||
|
||
<h1 align="center">Windows App SDK</h1> | ||
|
||
<h3 align="center"> | ||
<a href="https://learn.microsoft.com/windows/apps/windows-app-sdk">About</a> | ||
<span> · </span> | ||
<a href="https://learn.microsoft.com/windows/apps/desktop">Documentation</a> | ||
<span> · </span> | ||
<a href="https://learn.microsoft.com/windows/apps/windows-app-sdk/release-channels">Release notes</a> | ||
<span> · </span> | ||
<a href="https://github.com/microsoft/WindowsAppSDK-Samples">Samples</a> | ||
</h3> | ||
|
||
<p align="center"> | ||
<a style="text-decoration:none" href="https://www.nuget.org/packages/Microsoft.WindowsAppSDK"> | ||
<img src="https://img.shields.io/nuget/v/Microsoft.WindowsAppSDK" alt="WindowsAppSDK NuGet" /></a> | ||
</p> | ||
|
||
[Windows App SDK](https://aka.ms/winappsdk) (formerly Project Reunion) 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. | ||
|
||
- **WinUI 3 support:** [WinUI](https://aka.ms/winui) embodies Fluent Design to enable intuitive, accessible, and powerful experiences and the latest user interface patterns. | ||
- **Access modern features:** [Modern resource tooling](https://github.com/microsoft/WindowsAppSDK/issues/11), [modern lifecycle helpers](https://github.com/microsoft/WindowsAppSDK/issues/9), [startup tasks](https://github.com/microsoft/WindowsAppSDK/issues/10), and more without having to rewrite your app. | ||
- **Backwards compatibility:** Down to Windows 10 1809 (build 17763). There may be some API that are dependent on new OS features | ||
(like new Action Center functionality), however we will do our best to ensure this is the exception and not the norm, and provide reasonable fallbacks when possible. | ||
- **Wide platform support:** Win32, WPF, WinForms, and more. | ||
- **Use your current installer:** no requirement to use MSIX, but there are [reliability/security benefits to using MSIX](https://docs.microsoft.com/windows/msix/overview#key-features). | ||
|
||
## 📋 Getting started with Windows App SDK | ||
|
||
* [Build your first app with Windows App SDK](https://learn.microsoft.com/windows/apps/winui/winui3/create-your-first-winui3-app) | ||
* [Developer documentation](https://aka.ms/windowsappsdkdocs) | ||
* [Samples & resources](https://learn.microsoft.com/windows/apps/get-started/samples) | ||
* [Windows App SDK samples](https://github.com/microsoft/WindowsAppSDK-Samples) | ||
* [WinUI 3 Gallery](https://github.com/microsoft/WinUI-Gallery) | ||
* [AI Dev Gallery (Preview)](https://github.com/microsoft/ai-dev-gallery) | ||
* [Windows Community Toolkit](https://github.com/CommunityToolkit/Windows) | ||
* [Template Studio](https://github.com/microsoft/TemplateStudio) | ||
* [FAQ](docs/faq.md) | ||
* [Contribution guide](docs/contributor-guide.md) | ||
* [Roadmap](./docs/roadmap.md) | ||
* Windows App SDK family repositories | ||
* [WinUI](https://github.com/microsoft/microsoft-ui-xaml) | ||
* [C++/WinRT](https://github.com/microsoft/CppWinRT) and [C#/WinRT](https://github.com/microsoft/CsWinRT) | ||
* [MSIX packaging](https://github.com/microsoft/msix-packaging) | ||
|
||
## 👨💻 Join in and stay connected | ||
|
||
Interested in WinUI and Windows App SDK? Come join us on the quarterly [WinUI Community Calls](https://www.youtube.com/playlist?list=PLI_J2v67C23ZqsolUDaHoFkF1GKvGrttB). | ||
You can find and tag us on X using [#WindowsAppSDK](https://twitter.com/search?q=%23WindowsAppSDK). | ||
|
||
## 🖼️ 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 and Windows App SDK. | ||
|
||
<p align="center"><img src="./docs/images/winui-gallery.png" alt="WinUI 3 Gallery" width="400"/></p> | ||
|
||
<p align="center"> | ||
<a style="text-decoration:none" href="https://apps.microsoft.com/detail/9NGHP3DX8HDX?launch=true&mode=full"> | ||
<picture> | ||
<source media="(prefers-color-scheme: light)" srcset="https://get.microsoft.com/images/en-us%20dark.svg" width="200" /> | ||
<img src="https://get.microsoft.com/images/en-us%20light.svg" width="200" /> | ||
</picture></a> | ||
</p> | ||
|
||
## 📢 Contributing | ||
|
||
- **[File a new issue](https://github.com/microsoft/WindowsAppSDK/issues/new/choose):** Tell us what problem you're trying to solve, how you've tried to solve it so far, and what would be the ideal solution for your app. Bonus points if there's a gist or existing repo we can look at with you. | ||
- **[Ask a question](https://github.com/microsoft/WindowsAppSDK/discussions/categories/q-a):** Also, have a look at our [FAQ on WinAppSDK](docs/faq.md) page, which we will update periodically. | ||
- **[Start a discussion](https://github.com/microsoft/WindowsAppSDK/discussions):** Let's start a Discussion issue to see if others are interested in a cool new idea you've been thinking about that isn't quite ready to be filed as a more formal Feature Proposal. | ||
- **[Code contributions](docs/contributor-guide.md):** See our [contributing guidelines](docs/contributor-guide.md). | ||
|
||
## Data collection | ||
|
||
1. **[Ask a question](https://github.com/microsoft/WindowsAppSDK/discussions/categories/q-a)**<br> | ||
Also, have a look at our [frequently asked questions](docs/faq.md) page which we will update periodically. | ||
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. | ||
|
||
2. **[Start a discussion](https://github.com/microsoft/WindowsAppSDK/discussions)**<br> | ||
Discussions can be about any topics or ideas related to the Windows App SDK. For example, | ||
you might start a Discussion issue to see if others are interested in a cool new idea | ||
you've been thinking about that isn't quite ready to be filed as a more formal Feature Proposal. | ||
Privacy information can be found at https://privacy.microsoft.com | ||
|
||
3. **[Code contributions](docs/contributor-guide.md)**<br> | ||
More information regarding [contributing and developer guidelines here](docs/contributor-guide.md). | ||
## Code of Conduct | ||
|
||
## Data collection | ||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct). | ||
|
||
The software may collect information about you and your use of the software and send it | ||
to Microsoft. Microsoft may use this information to provide services and improve our | ||
products and services. You may turn off the telemetry as described in the repository. | ||
There are also some features in the software that may enable you and Microsoft to collect | ||
data from users of your applications. If you use these features, you must comply with | ||
applicable law, including providing appropriate notices to users of your applications | ||
together with a copy of Microsoft's privacy statement. Our privacy statement is located | ||
at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection | ||
and use in the help documentation and our privacy statement. Your use of the software | ||
operates as your consent to these practices. | ||
|
||
## Legal notices | ||
|
||
Microsoft and any contributors grant you a license to the Microsoft documentation and other content | ||
in this repository under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/legalcode), | ||
see the [LICENSE](LICENSE) file, and grant you a license to any code in the repository under the [MIT License](https://opensource.org/licenses/MIT), see the | ||
[LICENSE-CODE](LICENSE-CODE) file. | ||
|
||
Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation | ||
may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. | ||
The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks. | ||
Microsoft's general trademark guidelines can be found at http://go.microsoft.com/fwlink/?LinkID=254653. | ||
|
||
Privacy information can be found at https://privacy.microsoft.com/ | ||
|
||
Microsoft and any contributors reserve all other rights, whether under their respective copyrights, patents, | ||
or trademarks, whether by implication, estoppel or otherwise. | ||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq) or | ||
contact [[email protected]](mailto:[email protected]) with any additional questions or comments. |
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,69 +1,22 @@ | ||
# Welcome to MRT Core! | ||
<h1 align="center">MRT Core from Windows App SDK</h1> | ||
|
||
## Overview | ||
**MRT Core** (formaly, Core MRT or MRT) was born from the need for [Windows App SDK](https://aka.ms/windowsappsdk) applications to use MRT (Modern Resource Technology), introduced to Windows 8 and evolved as the modern resource management system since then. MRT Core provides support to build resources to Package Resource Index (PRI) files, and load resources from PRI files. The API is exposed to the namespace [Microsoft.Windows.ApplicationModel.Resources](https://learn.microsoft.com/windows/windows-app-sdk/api/winrt/microsoft.windows.applicationmodel.resources). | ||
|
||
### What is MRT Core? | ||
Thanks for asking! MRT Core was born from the need for [Windows App SDK](https://aka.ms/windowsappsdk) applications to use MRT - Modern Resource Technology. MRT was introduced to Windows in the Windows 8 timeframe and has evolved as the resource management system since that time. You can use these links to learn more about [MRT and resource management](https://docs.microsoft.com/windows/uwp/app-resources/resource-management-system) as well as the benefits of [globalization and localization](https://docs.microsoft.com/windows/uwp/design/globalizing/globalizing-portal). | ||
## Getting started with MRT Core | ||
|
||
> If you're looking for Core MRT, you're in the right place! Internal project naming was Core MRT and so some of our external communication has also used that terminology - sorry for any confusion! But rest assured, Core MRT or MRT Core, you're in the right place! 😉 | ||
- [About MRT Core & PRI](https://learn.microsoft.com/windows/apps/windows-app-sdk/mrtcore/mrtcore-overview) | ||
- [Migrate from MRT in UWP to MRT Core in WASDK](https://learn.microsoft.com/windows/apps/windows-app-sdk/migrate-to-windows-app-sdk/guides/mrtcore) | ||
- [Globalization and localization](https://learn.microsoft.com/windows/apps/design/globalizing/globalizing-portal) | ||
- [Qualify your resources](https://learn.microsoft.com/windows/apps/windows-app-sdk/mrtcore/tailor-resources-lang-scale-contrast) | ||
- [Localize your strings](https://learn.microsoft.com/windows/apps/windows-app-sdk/mrtcore/localize-strings) | ||
- [About PRI in Win32](https://learn.microsoft.com/en-us/windows/win32/menurc/pri-indexing-reference) | ||
|
||
### So what does it do? | ||
At its *core* 😎 MRT Core provides support to build resource Package Resource Index (PRI) files, and load resources from PRI files. [Learn more about PRI files at this link.](https://docs.microsoft.com/windows/uwp/app-resources/resource-management-system) | ||
## Building from source | ||
|
||
## Getting Started | ||
Install the NuGet package from [https://aka.ms/MRTCore](https://aka.ms/MRTCore), and you are ready to build PRI files from Visual Studio | ||
and use MRT Core APIs to load resources in your app. | ||
Open Visual Studio with `MrtCore.sln` and build the solution. | ||
|
||
The C APIs can be found in [mrm.h](mrt/Core/src/MRM.h). The WinRT APIs can be found in [Microsoft.Windows.ApplicationModel.Resources.idl](mrt/Microsoft.Windows.ApplicationModel.Resources/src/Microsoft.Windows.ApplicationModel.Resources.idl). | ||
|
||
## Build and Test | ||
Load [MrtCore.sln](mrt/MrtCore.sln) in Visual Studion 2019, and build the solution. | ||
|
||
Run the tests in Test Explorer. | ||
|
||
## Contribute | ||
|
||
This project welcomes contributions and suggestions. Most contributions require you to | ||
agree to a Contributor License Agreement (CLA) declaring that you have the right to, | ||
and actually do, grant us the rights to use your contribution. For details, visit | ||
https://cla.microsoft.com. | ||
|
||
When you submit a pull request, a CLA-bot will automatically determine whether you need | ||
to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the | ||
instructions provided by the bot. You will only need to do this once across all repositories using our CLA. | ||
|
||
## 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 [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
|
||
## Data Collection | ||
|
||
The software may collect information about you and your use of the software and send it | ||
to Microsoft. Microsoft may use this information to provide services and improve our | ||
products and services. You may turn off the telemetry as described in the repository. | ||
There are also some features in the software that may enable you and Microsoft to collect | ||
data from users of your applications. If you use these features, you must comply with | ||
applicable law, including providing appropriate notices to users of your applications | ||
together with a copy of Microsoft's privacy statement. Our privacy statement is located | ||
at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection | ||
and use in the help documentation and our privacy statement. Your use of the software | ||
operates as your consent to these practices. | ||
|
||
## Legal Notices | ||
|
||
Microsoft and any contributors grant you a license to the Microsoft documentation and other content | ||
in this repository under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/legalcode), | ||
and grant you a license to any code in the repository under the [MIT License](https://opensource.org/licenses/MIT), see the | ||
[LICENSE](../../LICENSE) file. | ||
|
||
Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation | ||
may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. | ||
The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks. | ||
Microsoft's general trademark guidelines can be found at http://go.microsoft.com/fwlink/?LinkID=254653. | ||
|
||
Privacy information can be found at https://privacy.microsoft.com/ | ||
|
||
Microsoft and any contributors reserve all other rights, whether under their respective copyrights, patents, | ||
or trademarks, whether by implication, estoppel or otherwise. | ||
The source code consists of three parts: | ||
- [The core runtime](mrt/mrm) | ||
- [PRI builder](mrt/mrm/include/mrm/build) | ||
- [Pure-C API](mrt/Core/src/MRM.h) over the core runtime | ||
- [WinRT API](mrt/Microsoft.Windows.ApplicationModel.Resources) wrapping the pure-C API |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.