|
| 1 | +# Project Reunion |
| 2 | + |
| 3 | +Project Reunion provides functionality that supports all your apps on Windows. |
| 4 | + |
| 5 | +## Roadmap |
| 6 | + |
| 7 | +We're following a [roadmap](docs/roadmap.md) that gets us to building a v1.0 of Reunion exploring |
| 8 | +some basic common features. You can help by filing issues for features you'd like to see! |
| 9 | + |
| 10 | +## Documentation |
| 11 | + |
| 12 | +* [Roadmap](docs/roadmap.md) - where we're going |
| 13 | +* [High-level overview](docs/overview.md) - why we're doing this, how you can use it |
| 14 | +* [Using Reunion](docs/developer-guide.md) - how to use Reunion in your app |
| 15 | +* [Contributor/developer Guide](docs/contributor-guide.md) - how to contribute to Reunion |
| 16 | +* [Implementation/API design Guide](docs/implementation-guide.md) - how to define and implement |
| 17 | + Reunion components. |
| 18 | +* [FAQ](docs/faq.md) - frequently asked questions about Project Reunion |
| 19 | + |
| 20 | +## Features |
| 21 | + |
| 22 | +### Benefits |
| 23 | + |
| 24 | +_Windows and Reunion loves all your apps_ |
| 25 | + |
| 26 | +The Reunion Framework helps you use modern features of Windows across all your apps, across all your |
| 27 | +users. You'll get access to modern features of the Windows Application Platform at your own pace. |
| 28 | +Improve power use and uphold privacy requirements in your existing apps. Update your app to use |
| 29 | +APIs that automatically switch to fill-in support on older versions of Windows. Get access to |
| 30 | +more of Windows from your UWPs. Connect to notifications from your Win32 applications. |
| 31 | + |
| 32 | +1. Reunion stays up to date automatically as new versions are available without recompilation or |
| 33 | +updates to your app. |
| 34 | + |
| 35 | +2. Reunion APIs are backwards-compatible across a range of Windows versions and provide a clear |
| 36 | +message to you that an API might not be supported. |
| 37 | + |
| 38 | +3. Reunion works for packaged, unpackaged, UWP, Desktop Bridge, and bring-your-own identity apps. |
| 39 | +Write your app or framework code once and use it everywhere. |
| 40 | + |
| 41 | +4. Reunion helps you incrementally adopt powerful Windows features like AppContainer, Desktop |
| 42 | +Bridge, Identity, and more. |
| 43 | + |
| 44 | +### API Support |
| 45 | + |
| 46 | +Reunion supports many of the APIs in Windows already. See below for a list and links to both |
| 47 | +definition and sample code. |
| 48 | + |
| 49 | +| Area | Description | IDL | Sample | |
| 50 | +| ------------- | ------------------------------------------------------------- | --- | ------ | |
| 51 | +| Startup Tasks | Schedule your app to run when the user logs in | | | |
| 52 | +| App Lifecycle | Events tracking app start & stop requests, login/out, restart | | | |
| 53 | +| Storage | Store your app's data in a central location per user | | | |
| 54 | + |
| 55 | + |
| 56 | +### Version Support |
| 57 | + |
| 58 | +At this time, Reunion supports Windows `TargetPlatformVersion` >= 10.0.18362 (Windows 10 1809) or |
| 59 | +greater. |
| 60 | + |
| 61 | +Your app's users can be on any of the following supported Windows 10 versions: |
| 62 | + |
| 63 | +* Windows Insider Previews |
| 64 | +* May 2019 Update (18362 aka "19H1") |
| 65 | +* October 2018 Update (17763 aka "Redstone 5") |
| 66 | +* April 2018 Update (17134 aka "Redstone 4") |
| 67 | +* Fall Creators Update (16299 aka "Redstone 3") |
| 68 | + |
| 69 | +When features have partial implementations on older versions of Windows they will have an |
| 70 | +[`IsSupported`](docs/developer-guide.md) method indicating what level of support is present. |
| 71 | + |
| 72 | +## Data/Telemetry |
| 73 | + |
| 74 | +This project collects usage data and sends it to Microsoft to help improve our products and services. See the [privacy statement](privacy.md) for more details. |
| 75 | + |
| 76 | +For more information on telemetry implementation see the [developer guide](docs/developer-guide.md#Telemetry). |
| 77 | + |
| 78 | +# Quick Start |
| 79 | + |
| 80 | +## Using Reunion in Your Apps |
| 81 | + |
| 82 | +There are [multiple samples available](samples/README.md). Briefly the steps are: |
| 83 | + |
| 84 | +1. [Add a reference](docs/developer-guide.md#Packages) to the Microsoft.Reunion package |
| 85 | +2. [Update your code](docs/developer-guide.md#UpdateYourApp) to use Reunion functionality |
| 86 | +3. [Deploy your app](docs/developer-guide.md#DeployingReunion) with Reunion |
| 87 | + |
| 88 | +## Requesting Reunion Functionality |
| 89 | + |
| 90 | +File a [new issue!](https://github.com/microsoft/ProjectReunion/issues/new/choose) Tell us what problem you're |
| 91 | +trying to solve, how you've tried to solve it so far, and what would be the ideal solution for your app. Bonus |
| 92 | +points if there's a gist or existing repo we can look at with you. There's [a fuller description](docs/expanding-reunion.md) |
| 93 | +of how this works, how you & the community can help, and more available. |
| 94 | + |
| 95 | +## Contributing to Union |
| 96 | + |
| 97 | +First, read the [Contributing](#Contributing) section. Then: |
| 98 | + |
| 99 | +1. Create a fork of this repo then clone it |
| 100 | +1. Start Visual Studio 2019 on [ProjectReunion.sln](./ProjectReunion.sln) |
| 101 | +1. [Modify the code](docs/implementation.md#UpdatingReunion) you'd like to see changed |
| 102 | +1. [Add tests](docs/implementation.md#Testing) for your fix or functionality |
| 103 | +1. [Create a pull request](docs/implementation.md#PullRequest) from your fork to this repo |
1 | 104 |
|
2 | 105 | # Contributing
|
3 | 106 |
|
|
0 commit comments