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

Commit

Permalink
Modify README to include usage information and resources.
Browse files Browse the repository at this point in the history
  • Loading branch information
conniey committed Feb 3, 2015
1 parent dbc3859 commit 5ce1946
Showing 1 changed file with 56 additions and 3 deletions.
59 changes: 56 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,57 @@
dotnet-apiport
==============
# .NET API Port

This repo contains APIPort client tools and libraries
This repository contains the source code for APIPort client tools and dependencies. This
is a work in progress, and does not currently contain all of the components
that we plan on open sourcing. Make sure to watch this repository in order to
be notified as we make changes to and expand it.

Today, the repository contains the following components:

* **Microsoft.Fx.Portability**. Provides common types for API Port.

* **Microsoft.Fx.Portability Tests**. Provides tests for Microsoft.Fx.Portability.

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. [K Version Manager (KVM)](https://github.com/aspnet/home#install-the-k-version-manager-kvm)
3. [K Runtime (KRE)](https://github.com/aspnet/home#install-the-k-runtime-environment-kre)

2. Add this feed to your NuGet package sources: https://www.myget.org/F/aspnetvnext/api/v2
* Wiki: [Configuring feeds used by KPM to Restore Packages](https://github.com/aspnet/Home/wiki/Configuring-the-feed-used-by-kpm-to-restore-packages)
3. Open Microsoft.Fx.Portability.sln in Visual Studio 2015
4. Build the solution
5. The .nupkgs for each supported platform should be under the bin/Debug or bin/Release folder

## How to Engage, Contribute and Provide Feedback

Some of the best ways to contribute are to try things out, file bugs, and join in design conversations.

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

* [Pull requests](https://github.com/Microsoft/dotnet-apiport/pulls): [Open](https://github.com/Microsoft/dotnet-apiport/pulls?q=is%3Aopen+is%3Apr)/[Closed](https://github.com/Microsoft/dotnet-apiport/pulls?q=is%3Apr+is%3Aclosed)

Looking for something to work on? The list of [up-for-grabs issues](https://github.com/Microsoft/dotnet-apiport/issues?q=is%3Aopen+is%3Aissue) 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][Contributing Guide] at the corefx repo wiki for more details.

* [How to Contribute][Contributing Guide]
* [Contributing Guide][Contributing Guide]
* [Developer Guide]

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

[Contributing Guide]: https://github.com/dotnet/corefx/wiki/Contributing
[Developer Guide]: https://github.com/dotnet/corefx/wiki/Developer-Guide

## Related Projects

For an overview of all the .NET related projects, have a look at the
[.NET home repository](https://github.com/Microsoft/dotnet).

## License

This project is licensed under the [MIT license](LICENSE).

0 comments on commit 5ce1946

Please sign in to comment.