Skip to content

Commit

Permalink
Updating md files (#967)
Browse files Browse the repository at this point in the history
  • Loading branch information
tfennel authored Jun 24, 2021
1 parent c0430c8 commit 869f2c0
Show file tree
Hide file tree
Showing 6 changed files with 82 additions and 80 deletions.
38 changes: 20 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Project Reunion - Calling all Windows apps!
# Windows App SDK - Calling all Windows developers!

*Previously known as Project Reunion*.

| Delight users with modern UI | Access new platform features | Backwards compatible |
|:--:|:--:|:--:|
Expand All @@ -8,15 +10,15 @@

* 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)!)*
* 100% additive *(only add what you need, leave the rest of your app as-is)*
* Works with Win32, WPF, WinForms, and UWP apps
* Works with Win32, WPF, WinForms, and more apps

Plus, **it's backwards compatible** to Windows 10 October 2018 Update (build 17763 / version 1809)!
Plus, **create beautiful, modern apps for Windows 11 that are backwards compatible** to Windows 10 October 2018 Update (build 17763 / version 1809)!


### Use it now!
[Packaged MSIX desktop apps](https://docs.microsoft.com/windows/msix/overview) can [use the 0.5 release](https://docs.microsoft.com/windows/apps/project-reunion/#get-started-developing-with-project-reunion) now!
[Packaged MSIX desktop apps](https://docs.microsoft.com/windows/msix/overview) can [use the 0.8 release](https://docs.microsoft.com/windows/apps/project-reunion/get-started-with-project-reunion) now!

Some notes about 0.5...
Some notes about 0.8...

* Requires using MSIX *(1.0 won't require MSIX)*
* Only includes WinUI 3 / Text rendering / Localization
Expand All @@ -26,12 +28,12 @@ Some notes about 0.5...

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](https://docs.microsoft.com/windows/msix/overview) desktop apps<br>(WPF, Win32, WinForms, console) | ✅ [WinUI 3](https://github.com/microsoft/microsoft-ui-xaml/blob/master/docs/roadmap.md#winui-3)<br>✅ [Text rendering](https://docs.microsoft.com/windows/apps/project-reunion/dwritecore)<br>✅ [Localization](https://docs.microsoft.com/windows/apps/project-reunion/mrtcore/mrtcore-overview) | ✅ [WinUI 3](https://github.com/microsoft/microsoft-ui-xaml/blob/master/docs/roadmap.md#winui-3)<br>✅ [Text rendering](https://docs.microsoft.com/windows/apps/project-reunion/dwritecore)<br>✅ [Localization](https://docs.microsoft.com/windows/apps/project-reunion/mrtcore/mrtcore-overview)<br>🔄 [App lifecycle](https://github.com/microsoft/ProjectReunion/issues/111) | ✅ [WinUI 3](https://github.com/microsoft/microsoft-ui-xaml/blob/master/docs/roadmap.md#winui-3)<br>✅ [Text rendering](https://github.com/microsoft/ProjectReunion/issues/112)<br>✅ [Localization](https://docs.microsoft.com/windows/apps/project-reunion/mrtcore/mrtcore-overview)<br>✅ [App lifecycle](https://github.com/microsoft/ProjectReunion/issues/111) <br>🔄 [Push Notifications](https://github.com/microsoft/ProjectReunion/issues/334) |
Unpackaged desktop apps<br>(WPF, Win32, WinForms, console) | ❌ Not supported | 🔄 [Text rendering](https://docs.microsoft.com/windows/apps/project-reunion/dwritecore)<br>🔄 [Localization](https://docs.microsoft.com/windows/apps/project-reunion/mrtcore/mrtcore-overview)<br>🔄 [App lifecycle](https://github.com/microsoft/ProjectReunion/issues/111) | ✅ [WinUI 3](https://github.com/microsoft/microsoft-ui-xaml/blob/master/docs/roadmap.md#winui-3)<br>✅ [Text rendering](https://docs.microsoft.com/windows/apps/project-reunion/dwritecore)<br>✅ [Localization](https://docs.microsoft.com/windows/apps/project-reunion/mrtcore/mrtcore-overview)<br>✅ [App lifecycle](https://github.com/microsoft/ProjectReunion/issues/111) <br>🔄 [Push Notifications](https://github.com/microsoft/ProjectReunion/issues/334) |
App type | Windows App SDK 0.8 | Windows App SDK 1.0 (Q4 2021) |
-- | ------------------------------- | ------------------------------- |
[Packaged MSIX](https://docs.microsoft.com/windows/msix/overview) desktop apps<br>(WPF, Win32, WinForms, console) | ✅ [WinUI 3](https://github.com/microsoft/microsoft-ui-xaml/blob/master/docs/roadmap.md#winui-3)<br>✅ [Text rendering](https://docs.microsoft.com/windows/apps/project-reunion/dwritecore)<br>✅ [Localization](https://docs.microsoft.com/windows/apps/project-reunion/mrtcore/mrtcore-overview)<br>🔄 [App lifecycle](https://github.com/microsoft/ProjectReunion/issues/111) | ✅ [WinUI 3](https://github.com/microsoft/microsoft-ui-xaml/blob/master/docs/roadmap.md#winui-3)<br>✅ [Text rendering](https://github.com/microsoft/ProjectReunion/issues/112)<br>✅ [Localization](https://docs.microsoft.com/windows/apps/project-reunion/mrtcore/mrtcore-overview)<br>✅ [App lifecycle](https://github.com/microsoft/ProjectReunion/issues/111) <br>🔄 [Push Notifications](https://github.com/microsoft/ProjectReunion/issues/334) |
Unpackaged desktop apps<br>(WPF, Win32, WinForms, console) | 🔄 [Text rendering](https://docs.microsoft.com/windows/apps/project-reunion/dwritecore)<br>🔄 [Localization](https://docs.microsoft.com/windows/apps/project-reunion/mrtcore/mrtcore-overview)<br>🔄 [App lifecycle](https://github.com/microsoft/ProjectReunion/issues/111) | ✅ [WinUI 3](https://github.com/microsoft/microsoft-ui-xaml/blob/master/docs/roadmap.md#winui-3)<br>✅ [Text rendering](https://docs.microsoft.com/windows/apps/project-reunion/dwritecore)<br>✅ [Localization](https://docs.microsoft.com/windows/apps/project-reunion/mrtcore/mrtcore-overview)<br>✅ [App lifecycle](https://github.com/microsoft/ProjectReunion/issues/111) <br>🔄 [Push Notifications](https://github.com/microsoft/ProjectReunion/issues/334) |

✅ Supported | 🔄 Preview
✅ Supported | 🔄 Experimental


See our [full roadmap](docs/roadmap.md) for more details.
Expand All @@ -40,7 +42,7 @@ See our [full roadmap](docs/roadmap.md) for more details.

### Version support

Project Reunion aims to work on supported versions of Windows.
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
Expand All @@ -53,12 +55,12 @@ this is the exception and not the norm, and provide reasonable fallbacks when po

### Documentation

* [More details about Project Reunion](https://github.com/microsoft/ProjectReunion/blob/master/docs/README.md) -
* [More details about the Windows App SDK](https://github.com/microsoft/ProjectReunion/blob/master/docs/README.md) -
More on what the project is and how we're approaching the work.
* [Video on Project Reunion](https://aka.ms/project_reunion_ignite) - Learn about Project Reunion in a 22 minute video!
* [Video on Windows App SDK](https://aka.ms/project_reunion_ignite) - Learn about the Windows App SDK in a 22 minute video!
* [Roadmap](docs/roadmap.md) - Where we're going!
* [Contributor guide](docs/contributor-guide.md) - How to contribute to Project Reunion.
* [FAQ](docs/faq.md) - Frequently asked questions about Project Reunion.
* [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.


### Contributing
Expand All @@ -77,15 +79,15 @@ points if there's a gist or existing repo we can look at with you.
Also, have a look at our [frequently asked questions](docs/faq.md) page which we will update periodically.

2. **[Start a discussion](https://github.com/microsoft/ProjectReunion/discussions)**<br>
Discussions can be about any topics or ideas related to Project Reunion. For example,
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.

3. **[Make a feature proposal](https://github.com/microsoft/ProjectReunion/issues/new?assignees=&labels=feature+proposal&template=feature-proposal.md&title=)**<br>
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.
What components do you want to see in the Windows App SDK? 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.**
**Over time, we will add Windows App SDK code and samples into this repo and provide code contribution/developer guidelines.**

Read more about the [contribution guide here](docs/contributor-guide.md).

Expand Down
2 changes: 1 addition & 1 deletion docs/Coding-Guidelines.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# General

Project Reunion prefers using industry-standard coding styles, guidelines, and patterns for any
The Windows App SDK prefers using industry-standard coding styles, guidelines, and patterns for any
languages used in implementation or testing.

## Languages
Expand Down
6 changes: 3 additions & 3 deletions docs/contributor-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@ points if there's a gist or existing repo we can look at with you.
Also, have a look at our [frequently asked questions](faq.md) page which we will update often.

2. **[Start a discussion](https://github.com/microsoft/ProjectReunion/discussions)**<br>
Discussions can be about any topics or ideas related to Project Reunion.For example,
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.

3. **[Make a feature proposal](https://github.com/microsoft/ProjectReunion/issues/new?assignees=&labels=feature+proposal&template=feature-proposal.md&title=)**<br>
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.
What components do you want to see in the Windows App SDK? 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.**
**Over time, we will add Windows App SDK code and samples into this repo and provide code contribution/developer guidelines.**


Most contributions require you to agree to a
Expand Down
Loading

0 comments on commit 869f2c0

Please sign in to comment.