Skip to content
This repository has been archived by the owner on Jul 15, 2023. It is now read-only.

Latest commit

 

History

History
90 lines (65 loc) · 4.18 KB

README.md

File metadata and controls

90 lines (65 loc) · 4.18 KB

.NET API Portability

This repository contains the source code for .NET Portability Analyzer tools and dependencies.

Usage

To use this tool, please refer to the documentation. For a quick introduction, check out this video on Channel 9:

Projects

Project Description
ApiPort Console tool to access portability webservice
ApiPort.Core Cross-platform .NET Core application
ApiPort.Vsix Visual Studio Extension
Microsoft.Fx.Portability Provides common types for API Port
Microsoft.Fx.Portability.MetadataReader Implements a dependency finder based off of System.Reflection.Metadata. The library will generate DocIds that conform to these specifications.
Microsoft.Fx.Portability.Offline Provides access to data in an offline setting so network calls are not needed
Microsoft.Fx.Portability.Reporting.Html Provides an HTML report for ApiPort (used in offline mode)
Microsoft.Fx.Portability.Reporting.Json Provides a JSON reporter for ApiPort (used in offline mode)

Using this Repository

ApiPort.Core

Prerequisites

Compiling, Debugging and Running

  • Change Platform to x64
  • Compile solution
  • Run/debug the solution by:
    • Executing: dotnet.exe ApiPort.exe [arguments]
    • Debug ApiPort.Core project in Visual Studio

How to Engage, Contribute and Provide Feedback

Here are some ways to contribute:

Want to get more familiar with what's going on in the code?

Looking for something to work on? The list of up-for-grabs issues is a great place to start.

We're re-using the same contributing approach as .NET Core. You can check out the .NET Core contributing guide at the corefx repo wiki for more details.

You are also encouraged to start a discussion on the .NET Foundation forums!

Related Projects

For an overview of all the .NET related projects, have a look at the .NET home repository.

License

This project is licensed under the MIT license.