Skip to content

Latest commit

 

History

History
125 lines (84 loc) · 9.67 KB

README.md

File metadata and controls

125 lines (84 loc) · 9.67 KB

Project Reunion - Calling all Windows apps!

Delight users with modern UI Access new platform features Backwards compatible
Modern navigation
Powerful WinUI 3 UI
Platform logo
Localization + power status + more
Down-level logo
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!)
  • 100% additive (only add what you need, leave the rest of your app as-is)
  • Works with Win32, WPF, WinForms, and UWP apps

Plus, it's backwards compatible to Windows 10 October 2018 Update (build 17763 / version 1809)!

Use it now!

Packaged MSIX desktop apps can use the 0.5 release now!

Some notes about 0.5...

  • Requires using MSIX (1.0 won't require MSIX)
  • Only includes WinUI 3 / Text rendering / Localization
  • To use WinUI 3, it's best to start a new app project and, if useful, copy any existing code/business logic from past projects into the new project (in the future, XAML Islands will enable incrementally adopting WinUI 3)

Please let us know how we can make this repo better. Your voice matters!

The Windows Developer Platform team strives to continually improve the developer experience on our open-source GitHub repositories. Survey responses will not be associated with any personal information. Data collected will only be used to improve this repository. This survey will take approximately 4-7 minutes to complete. You can find the Project Reunion Survey here.

Thank you for your time and consideration to do this! Our team truly appreciates you! 👌🤩

Roadmap

Here's a snippet of what we intend to deliver in 2021 (times/features/releases are tentative and subject to change):

App type Reunion 0.5 Reunion 0.8 (Q2 2021) Reunion 1.0 (Q4 2021)
Packaged MSIX desktop apps
(WPF, Win32, WinForms, console)
WinUI 3
Text rendering
Localization
WinUI 3
Text rendering
Localization
🔄 App lifecycle
WinUI 3
Text rendering
Localization
App lifecycle
Unpackaged desktop apps
(WPF, Win32, WinForms, console)
❌ Not supported 🔄 Text rendering
🔄 Localization
🔄 App lifecycle
WinUI 3
Text rendering
Localization
App lifecycle

✅ Supported | 🔄 Preview

See our full roadmap for more details.

Version support

Project Reunion 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.

Documentation

Contributing

Feature Proposals Bugs

We want to hear from you!

File a new issue! 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.

  1. Ask a question
    Also, have a look at our frequently asked questions page which we will update periodically.

  2. Start a discussion
    Discussions can be about any topics or ideas related to Project Reunion. 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.

  3. Make a feature proposal
    What components do you want to see in Project Reunion? For example you can propose a new API on an existing type, or an idea for a new API. It's fine if you don't have all the details: you can start with a summary and rationale.

Over time, we will add Project Reunion code and samples into this repo and provide code contribution/developer guidelines.

Read more about the contribution guide here.

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, see the LICENSE file, and grant you a license to any code in the repository under the MIT License, see the 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.