diff --git a/README.md b/README.md index 4f3e4d2314..4d0c46b166 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,66 @@ Universe Build infrastructure used to produce the whole ASP.NET Core stack. -## Getting started +## Released Builds + +### ASP.NET Core Runtime Store + +The runtime store can be downloaded from [here](https://microsoft.com/net/download). + +### NuGet packages + +All published ASP.NET Core packages can be found on . + +Commonly referenced packages: + +[all-metapackage-nuget]: https://nuget.org/packages/Microsoft.AspNetCore.All +[all-metapackage-nuget-badge]: http://img.shields.io/nuget/v/Microsoft.AspNetCore.All.svg?style=flat-square&label=nuget + +[metapackage-nuget]: https://nuget.org/packages/Microsoft.AspNetCore +[metapackage-nuget-badge]: http://img.shields.io/nuget/v/Microsoft.AspNetCore.svg?style=flat-square&label=nuget + +Package | NuGet.org +----------------------------------|------------------- +Microsoft.AspNetCore.All | [![][all-metapackage-nuget-badge]][all-metapackage-nuget] +Microsoft.AspNetCore | [![][metapackage-nuget-badge]][metapackage-nuget] + + +## Daily builds + +### NuGet packages + +Packages can be found on . This feed may include +packages that will not be supported in a officially released build. + +Commonly referenced packages: + +[all-metapackage-myget]: https://dotnet.myget.org/feed/aspnetcore-dev/package/nuget/Microsoft.AspNetCore.All +[all-metapackage-myget-badge]: http://img.shields.io/dotnet.myget/aspnetcore-dev/v/Microsoft.AspNetCore.All.svg?style=flat-square&label=myget + +[metapackage-myget]: https://dotnet.myget.org/feed/aspnetcore-dev/package/nuget/Microsoft.AspNetCore +[metapackage-myget-badge]: http://img.shields.io/dotnet.myget/aspnetcore-dev/v/Microsoft.AspNetCore.svg?style=flat-square&label=myget + +Package | MyGet +----------------------------------|------------------- +Microsoft.AspNetCore.All | [![][all-metapackage-myget-badge]][all-metapackage-myget] +Microsoft.AspNetCore | [![][metapackage-myget-badge]][metapackage-myget] + +### ASP.NET Core Shared Framework + +[win-x64-badge]: https://dotnetcli.blob.core.windows.net/dotnet/Runtime/master/aspnetcore-runtime-win-x64-version-badge.svg +[win-x86-badge]: https://dotnetcli.blob.core.windows.net/dotnet/Runtime/master/aspnetcore-runtime-win-x86-version-badge.svg +[linux-x64-badge]: https://dotnetcli.blob.core.windows.net/dotnet/Runtime/master/aspnetcore-runtime-linux-x64-version-badge.svg +[osx-x64-badge]: https://dotnetcli.blob.core.windows.net/dotnet/Runtime/master/aspnetcore-runtime-osx-x64-version-badge.svg + + +Platform | Latest (dev branch) +----------------|--------------------- +Windows (x64) | ![][win-x64-badge] +Windows (x86) | ![][win-x86-badge] +Linux (x64) | ![][linux-x64-badge] +macOS (x64) | ![][osx-x64-badge] + +## Building from source ``` git clone --recursive https://github.com/aspnet/Universe.git @@ -11,13 +70,13 @@ cd Universe ./build.cmd ``` -## Useful properties and targets +### Useful properties and targets Property | Purpose | Example -----------------------------------|--------------------------------------------------------------------------------|-------- -`/p:SkipTests`/`/p:CompileOnly` | Only build repos, don't run the tests. | `/p:SkipTests=true` -`/p:TestOnly` | Don't package or verify things. | `/p:TestOnly=true` -`ENV:KOREBUILD_REPOSITORY_INCLUDE` | A list of the repositories to include in build (instead of all of them). | `ENV:KOREBUILD_REPOSITORY_INCLUDE=Antiforgery;CORS` -`ENV:KOREBUILD_REPOSITORY_EXCLUDE` | A list of the repositories to exclude from build (all the rest will be built). | `ENV:KOREBUILD_REPOSITORY_EXCLUDE=EntityFramework` +`SkipTests` | Only build repos, don't run the tests. | `/p:SkipTests=true` +`TestOnly` | Don't package or verify things. | `/p:TestOnly=true` +`KOREBUILD_REPOSITORY_INCLUDE` | A list of the repositories to include in build (instead of all of them). | `$env:KOREBUILD_REPOSITORY_INCLUDE='Antiforgery;CORS'` +`KOREBUILD_REPOSITORY_EXCLUDE` | A list of the repositories to exclude from build (all the rest will be built). | `$env:KOREBUILD_REPOSITORY_EXCLUDE='EntityFramework'` ## More info