From aa8c3497ab9ab9bdc042f4ae78551c8db7182e87 Mon Sep 17 00:00:00 2001 From: Chris Ross Date: Wed, 1 Jul 2020 05:58:49 -0700 Subject: [PATCH] Add instructions for using daily builds (#280) * Create DailyBuilds.md * Update README.md * Add Getting Started link * Link to getting started --- README.md | 4 +++- docs/DailyBuilds.md | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 docs/DailyBuilds.md diff --git a/README.md b/README.md index a110e1326..954cceace 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,9 @@ If you're having trouble building the project, or developing in Visual Studio, p # Getting started -Take a look at the [sample apps](samples/), for some examples of how to use YARP. We'll be publishing more [docs](https://microsoft.github.io/reverse-proxy/) and tutorials as the project develops! +- See our [Getting Started](https://microsoft.github.io/reverse-proxy/articles/getting_started.html) docs. +- Try our [previews](https://github.com/microsoft/reverse-proxy/releases). +- Try our latest [daily build](/docs/DailyBuilds.md). # Roadmap diff --git a/docs/DailyBuilds.md b/docs/DailyBuilds.md new file mode 100644 index 000000000..17df3021d --- /dev/null +++ b/docs/DailyBuilds.md @@ -0,0 +1,34 @@ +How to get daily builds of YARP +=============================== + +Daily builds include the latest source code changes. They are not supported for production use and are subject to frequent changes, but we strive to make sure daily builds function correctly. + +If you want to download the latest daily build and use it in a project, then you need to: + +- Obtain the latest [build of the .NET Core SDK](https://github.com/dotnet/core-sdk#installers-and-binaries). +- Add a NuGet.Config to your project directory with the following content: + + ```xml + + + + + + + + + ``` + + *NOTE: This NuGet.Config should be with your application unless you want nightly packages to potentially start being restored for other apps on the machine.* + +Then follow the [Getting Started](https://microsoft.github.io/reverse-proxy/articles/getting_started.html) guide to set up a project and add the nuget package dependency. Note daily builds use a higher preview version than given in the docs. + +Some features, such as new target frameworks, may require prerelease tooling builds for Visual Studio. +These are available in the [Visual Studio Preview](https://www.visualstudio.com/vs/preview/). + +#### To debug daily builds using Visual Studio + +* *Enable Source Link support* in Visual Studio should be enabled. +* *Enable source server support* in Visual should be enabled. +* *Enable Just My Code* should be disabled +* Under Symbols enable the *Microsoft Symbol Servers* setting.