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

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
twsouthwick committed Aug 6, 2015
1 parent 27184b1 commit eaff71a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 20 deletions.
2 changes: 2 additions & 0 deletions PortabilityTools.sln
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ MinimumVisualStudioVersion = 10.0.40219.1
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{C991F5FC-04B5-420C-98A0-80974AA946F7}"
ProjectSection(SolutionItems) = preProject
global.json = global.json
LICENSE = LICENSE
NuGet.config = NuGet.config
README.md = README.md
EndProjectSection
ProjectSection(FolderGlobals) = preProject
global_1json__JSONSchema = http://json.schemastore.org/global
Expand Down
24 changes: 4 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,34 +11,18 @@ Today, the repository contains the following components:

* **src/ApiPort** Console tool to access portability webservice.
* **src/Microsoft.Fx.Portability** Provides common types for API Port.
* **src/Microsoft.Fx.Portability-net45** A project targeting .NET 4.5 of Microsoft.Fx.Portability to allow desktop apps to directly reference it. *Currently a work-around for beta VS 2015 behavior.*
* **src/Microsoft.Fx.Portability.MetadataReader** Implements a dependency finder based off of [System.Reflection.Metadata](https://github.com/dotnet/corefx/tree/master/src/System.Reflection.Metadata). The library will generate DocIds that conform to [these specifications](https://msdn.microsoft.com/en-us/library/fsbx0t7x.aspx).
* **src/Microsoft.Fx.Portability.Offline** Provides access to data in an offline setting so network calls are not needed
* **src/Microsoft.Fx.Portability.Reporting.Html** Provides an HTML report for ApiPort (used in offline mode)
* **src/Microsoft.Fx.Portability.Reporting.Json** Provides a JSON reporter for ApiPort (used in offline mode)
* **tests/Microsoft.Fx.Portability.Tests** Provides tests for Microsoft.Fx.Portability.
* **tests/Microsoft.Fx.Portability.MetadataReader.Tests** Provides tests for Microsoft.Fx.Portability.MetadataReader.

More libraries are coming soon. Stay tuned!

## Using this Repository

1. Install the following:
1. [Visual Studio 2015](http://www.visualstudio.com/en-us/downloads/visual-studio-2015-downloads-vs.aspx)
2. [.NET Version Manager (DNVM)](https://github.com/aspnet/home#getting-started-with-aspnet-5-and-dnx)
3. [.NET Execution Environment (DNX)](https://github.com/aspnet/home#running-an-application)

### Building from Commandline
1. Go to `src\Microsoft.Fx.Portability`
2. Run command: `dnu restore`
3. Run command: `dnu pack`

### Building from Visual Studio
1. Open PortabilityTools.sln in Visual Studio 2015
2. Build the solution
3. The .nupkg should be under the bin/Debug or bin/Release folders

### Running the Tests
1. Go to `tests\Microsoft.Fx.Portability.Tests`
2. Run command: `dnu restore`
3. Run command: `dnx . test`
* **Required** Install [Visual Studio 2015](http://www.visualstudio.com/en-us/downloads/visual-studio-2015-downloads-vs.aspx)

## How to Engage, Contribute and Provide Feedback

Expand Down

0 comments on commit eaff71a

Please sign in to comment.