-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Merge initial README changes #23
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
Closed
Closed
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
f5490b6
Update README.md
ptorr-msft ecac402
Update README.md
ptorr-msft f61a313
Update README.md
ptorr-msft 7fa9f68
Update README.md
ptorr-msft e39832c
Update README.md
ptorr-msft e07b445
Update README.md
ptorr-msft 996b7d5
Update README.md
ptorr-msft cada5be
Update README.md
ptorr-msft d06c6da
Update README.md
ptorr-msft aa12668
Update README.md
drewnoakes 390657f
Update README.md
ptorr-msft 66b070a
Update README.md
ptorr-msft da8b617
Update README.md
ptorr-msft 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 hidden or 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,5 +1,42 @@ | ||
# Windows Presentation Framework (WPF) | ||
This repo contains the open-source components of Windows Presentation Foundation (WPF) that run on top of .NET Core 3. This is based on, but separate from, the version of WPF that is supported in the Windows Desktop .NET Framework. | ||
|
||
For now, this is just building a simple Hello World project :) | ||
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). | ||
|
||
> note that this URL doesn't exist yet - I assume 3.0 will come online soon? | ||
|
||
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). There are also some WPF features, such as [XAML Browser applications (XBAPs)](https://docs.microsoft.com/en-us/dotnet/framework/wpf/app-development/wpf-xaml-browser-applications-overview) that are not supported on .NET Core 3. A full list of supported / unsupported features will be available in a future update. | ||
|
||
Additionally, some .NET Framework features (such as partial-trust applications, speech, remoting, and AppDomains) are not supported at this time on .NET Core. 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. See the Visual C++ section of [the Visual Studio 2017 redistributable files list](https://docs.microsoft.com/en-us/visualstudio/productinfo/2017-redistribution-vs#VisualStudio) for more information. You can also [follow this issue in /dotnet/core-setup](https://github.com/dotnet/core-sdk/issues/160#issuecomment-440103176) for future updates. | ||
* There is currently no XAML Designer support for WPF on .NET Core. If you want to use the XAML Designer, you will need to do that in the context of a .NET Framework (Desktop) project, eg by "linking" the .NET Core files into a .NET Framework project. | ||
|
||
# How to build the code | ||
Currently, this repo only contains the `System.Xaml` assembly and its related tests. It is not sufficient to build a complete version of WPF, but you can rebuild `System.Xaml.dll` and run the associated tests. | ||
ptorr-msft marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## To build `System.Xaml` | ||
|
||
* In the root of your repo, run `build` (or `build -verbose` for logs). | ||
|
||
## To run the tests | ||
|
||
* In the root of your repo, run `test` or open the solution file `src\Microsoft.DotNet.Wpf\test\DRT\DrtXaml.sln` ("DRT" is an internal name used for unit tests). *Note that this will test the version of `System.Xaml.dll` currently installed in your shared framework;* if you rebuild `System.Xaml.dll` and want to test your changes, you will need to replace the current DLL with your own (be sure to make a backup first). | ||
|
||
# Contribution guidelines | ||
## Issues | ||
* If you have feedback (bug report, feature suggestion, etc.) *specifically* about WPF on .NET Core 3, please [open a new issue here](https://github.com/dotnet/wpf/issues/). | ||
* If you have more general feedback about .NET Core 3, please use the [dotnet/core](https://github.com/dotnet/core) repo. | ||
* 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 WinUI XAML). | ||
|
||
## Code | ||
We will not be merging any pull requests to WPF at this time; we will update this section with contribution guidelines as we move closer to an initial full release of the code. In the meantime, if you have any suggestions for changes to WPF please [open an issue](https://github.com/dotnet/wpf/issues/) where we can discuss potential future updates. | ||
|
||
# Code of conduct | ||
The WPF repo follows the [.NET Foundation Code of Condut](http://www.dotnetfoundation.org/code-of-conduct). | ||
|
||
[](https://dnceng.visualstudio.com/internal/_build/latest?definitionId=234) |
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.