Merge initial README changes #23

ptorr-msft · 2018-11-20T20:02:58Z

Basic README for the Preview 1 release. Still has a couple of placeholders but wanted something close to ready.

Started adding info

Added known issue for vcruntime and designer support

Added info on building and cleaned up contributions section

Updated docs info / links

drewnoakes

A few typos.

README.md

rladuca · 2018-11-20T20:36:33Z

README.md

+Most of the [conceptual documentation for WPF on Desktop](https://docs.microsoft.com/en-us/visualstudio/designers/getting-started-with-wpf?view=vs-2017) applies equally well to WPF on .NET Core 3. The main differences are around project structure and lack of Designer support (see **Known issues**, below). All WPF features are available on .NET Core 3, but some .NET Framework features (such as remoting or AppDomains) are not supported. See [**insert some link to .NET Core docs**](http://msdn.microsoft.com) for more info
+
+# Known issues
+* WPF relies on the VCRuntime redistributable package. For this initial release, you will need to install the VCRuntime redistributable on any machines where you want WPF applications to run. You can [follow this issue in /dotnet/core-setup](https://github.com/dotnet/core-sdk/issues/160#issuecomment-440103176) for more information.


I think we want a link to the vcruntime here. The issue I sent was just in case we wanted to have a GitHub issue link for each known issue. But I think maybe it makes more sense to start our own issue in the WPF repo and then link to that. Thoughts @vatsan-madhavan ?

When solutions are expected to be made in the wpf codebase, we should file corresponding issues under /wpf. If issues are expected to be solved elsewhere, then we should file them where they are expected to be solved. For now, the vcruntime problem seems to have an unclear 'home'. I think it is owned by the VC libs or the Compiler team, but there is also an onus on us (WPF team) to drive a solution for this (or consume a partial solution, like a privatized runtime ). Given its particular complexity, I would open an issue for this one under /wpf and link to it with details.

rladuca · 2018-11-20T20:37:34Z

README.md

+
+# Known issues
+* WPF relies on the VCRuntime redistributable package. For this initial release, you will need to install the VCRuntime redistributable on any machines where you want WPF applications to run. You can [follow this issue in /dotnet/core-setup](https://github.com/dotnet/core-sdk/issues/160#issuecomment-440103176) for more information.
+* There is currently no XAML Designer support for WPF on .NET Core. If you wantto use the XAML Designer, you will need to do that in the context of a .NET Framework (Desktop) project. 


Have we verified that the multi-target scenario where net472 is the first target framework allows the designer to be used? If so and VS signs off on that, should we tell people to use that as a workaround in the meantime?

I do this all the time, and works well for me. Both the designer, and the Test runner, respect only the first entry in <TargetFrameworks/>. I just verified it on a project from yesterdays SDK bits, and it continues to work well.

Instead of asking for a hard support statement from IDE folks (I'm not discouraging us from following this through - I'm just worried that asking for a "sign off" for somethign like this would not be forthcoming easily), we should consider framing our knowledge of this workaround as a fragile-yet-functional workaround which is not guaranteed to work forever, and possibly mention that we hope to build appropriate first-class IDE experiences "soon". In the meantime, if IDE folks are willing to guarantee that this will work reliably, then we can ugprade our verbiage appropriately. Just my 2c.

Will experiment and add this info in update to PR. Thanks!

README.md

rladuca · 2018-11-20T20:41:00Z

README.md

+* If you have feedback about WPF on the Desktop Framework, please report it using the Feedback Hub on Windows 10 (Category: *Developer Platfornm*, sub-category *UI frameworks and controls* and make it clear your feedback is for WPF, not UWP XAML).
+
+## Code
+We are not accepting pull requests to WPF at this time; we will udpate this section with contribution guidelines as we move closer to an initial full release of the code.


This is not true as per my last understanding of the plan. We will accept PRs, but not merge them. I assume if this is a distinction we are making internally, we should also make it externally.

Added something along those lines; please take a look.

dnfclas · 2018-11-20T20:43:57Z

All CLA requirements met.

Update based on review feedback

README.md

Co-Authored-By: ptorr-msft <[email protected]>

Added more wording to Code contributions

diverdan92 · 2018-11-21T19:07:39Z

README.md

+Currently, only a subset of the full WPF Framework is available as open-source (`System.Xaml` and related tests); more code will be pushed to the repo over the coming months. 
+
+# Using the code
+To get started using WPF on .NET Core 3, follow the [Getting Started instructions](https://github.com/dotnet/samples/tree/master/wpf). The WPF APIs are documented on MSDN in the [.NET API Browser](https://docs.microsoft.com/en-us/dotnet/api/?view=netstandard-2.0).


Should the getting started instructions live in this repo, and the samples repo points back here for basic getting started instructions? @richlander

I think we need to update the API reference list, but I don't know if it will be ready in time for Preview 1. Should we remove this line for now?

Few minor updates

Tweaked wording for designer.

karelz · 2018-11-30T20:26:55Z

@ptorr-msft as discussed offline, I put up docs in another PR - see #32 and pending #33
Here's list of things from your PR I did not cover there yet:

.NET API Browser link, conceptual docs link - https://github.com/dotnet/wpf/blob/da8b617a3bc67b78cea6ca225d0c66837ff537e4/README.md#using-the-code
- Do you want to add them somewhere into Getting Started doc? (I wasn't sure how best to add it there, so I didn't do it)
List of known issues: https://github.com/dotnet/wpf/blob/da8b617a3bc67b78cea6ca225d0c66837ff537e4/README.md#known-issues
- Lack XAML Designer of XAML designer is listed in Getting Started doc
- Should we mention the VCRuntime as installation prereq in the same Getting Started doc? Is it planned to be addressed in 3.0 or in Future release? (it was not clear to me from the wording)

I believe the rest is covered in my docs. Including limiting PR contributions to "parity with WPF for .NET Framework" (different wording for https://github.com/dotnet/wpf/blob/da8b617a3bc67b78cea6ca225d0c66837ff537e4/README.md#code).

ptorr-msft · 2018-11-30T21:02:25Z

Closing this in favour of Karel's PR; I will add missing pieces back to that.

ptorr-msft added 7 commits November 16, 2018 17:59

Update README.md

f5490b6

Started adding info

Update README.md

ecac402

Update README.md

f61a313

Update README.md

7fa9f68

Update README.md

e39832c

Added known issue for vcruntime and designer support

Update README.md

e07b445

Added info on building and cleaned up contributions section

Update README.md

996b7d5

Updated docs info / links

ptorr-msft requested review from richlander, diverdan92, rladuca, vatsan-madhavan, merriemcgaw, OliaG and fabiant3-zz November 20, 2018 20:02

drewnoakes reviewed Nov 20, 2018

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

rladuca reviewed Nov 20, 2018

View reviewed changes

README.md Outdated Show resolved Hide resolved

rladuca reviewed Nov 20, 2018

View reviewed changes

README.md Show resolved Hide resolved

rladuca reviewed Nov 20, 2018

View reviewed changes

Update README.md

cada5be

Update README.md

d06c6da

Update based on review feedback

drewnoakes reviewed Nov 20, 2018

View reviewed changes

README.md Outdated Show resolved Hide resolved

drewnoakes and others added 2 commits November 20, 2018 16:21

Update README.md

aa12668

Co-Authored-By: ptorr-msft <[email protected]>

Update README.md

390657f

Added more wording to Code contributions

diverdan92 reviewed Nov 21, 2018

View reviewed changes

dotnet deleted a comment from drewnoakes Nov 27, 2018

ptorr-msft added 2 commits November 27, 2018 09:55

Update README.md

66b070a

Few minor updates

Update README.md

da8b617

Tweaked wording for designer.

karelz mentioned this pull request Nov 30, 2018

Initial repo docs #32

Merged

ptorr-msft closed this Nov 30, 2018

ptorr-msft deleted the user/ptorr branch November 30, 2018 21:07

ghost locked as resolved and limited conversation to collaborators Apr 18, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Merge initial README changes #23

Merge initial README changes #23

ptorr-msft commented Nov 20, 2018

drewnoakes left a comment

rladuca Nov 20, 2018

vatsan-madhavan Nov 20, 2018

rladuca Nov 20, 2018

vatsan-madhavan Nov 20, 2018

ptorr-msft Nov 20, 2018

rladuca Nov 20, 2018

ptorr-msft Nov 21, 2018

dnfclas commented Nov 20, 2018 •

edited

Loading

diverdan92 Nov 21, 2018

karelz commented Nov 30, 2018

ptorr-msft commented Nov 30, 2018

Merge initial README changes #23

Merge initial README changes #23

Conversation

ptorr-msft commented Nov 20, 2018

drewnoakes left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dnfclas commented Nov 20, 2018 • edited Loading

Choose a reason for hiding this comment

karelz commented Nov 30, 2018

ptorr-msft commented Nov 30, 2018

dnfclas commented Nov 20, 2018 •

edited

Loading