From 9a4fe1482b8fb172df43f0b0a60eedb843175820 Mon Sep 17 00:00:00 2001 From: Bettina Heim Date: Sat, 12 Sep 2020 07:03:39 -0700 Subject: [PATCH] renaming master -> main --- README.md | 2 +- examples/CompilerExtensions/ExtensionPackage/README.md | 4 ++-- src/QuantumSdk/README.md | 6 +++--- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3504d95dd4..0a34f2f1e7 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ This repository includes both C# and F# code, as well as .csproj and .fsproj pro | branch | status | |--------|-----------| -| master | [![Build Status](https://dev.azure.com/ms-quantum-public/Microsoft%20Quantum%20(public)/_apis/build/status/microsoft.qsharp-compiler?branchName=master)](https://dev.azure.com/ms-quantum-public/Microsoft%20Quantum%20(public)/_build/latest?definitionId=14&branchName=master) | +| main | [![Build Status](https://dev.azure.com/ms-quantum-public/Microsoft%20Quantum%20(public)/_apis/build/status/microsoft.qsharp-compiler?branchName=main)](https://dev.azure.com/ms-quantum-public/Microsoft%20Quantum%20(public)/_build/latest?definitionId=14&branchName=main) | ## Feedback ## diff --git a/examples/CompilerExtensions/ExtensionPackage/README.md b/examples/CompilerExtensions/ExtensionPackage/README.md index 9b1721546a..6af6e37480 100644 --- a/examples/CompilerExtensions/ExtensionPackage/README.md +++ b/examples/CompilerExtensions/ExtensionPackage/README.md @@ -1,6 +1,6 @@ # Creating a NuGet package containing a Q# compiler extension -This project contains a template for packaging a Q# compiler extension. For more information about Q# compiler extensions see [here](https://github.com/microsoft/qsharp-compiler/tree/master/src/QuantumSdk#extending-the-q-compiler). For more information on NuGet packages, see [here](https://docs.microsoft.com/en-us/nuget/what-is-nuget). +This project contains a template for packaging a Q# compiler extension. For more information about Q# compiler extensions see [here](https://github.com/microsoft/qsharp-compiler/tree/main/src/QuantumSdk#extending-the-q-compiler). For more information on NuGet packages, see [here](https://docs.microsoft.com/en-us/nuget/what-is-nuget). Prerequisites: [NuGet tools](https://docs.microsoft.com/en-us/nuget/install-nuget-client-tools) @@ -14,4 +14,4 @@ In order to use the created package as a Q# compiler extension when building a Q ``` ``` -The extension will only be included in the build process if`IsQscReference` is set to `true`. For more information, see this [readme](https://github.com/microsoft/qsharp-compiler/blob/master/src/QuantumSdk/README.md). +The extension will only be included in the build process if`IsQscReference` is set to `true`. For more information, see this [readme](https://github.com/microsoft/qsharp-compiler/blob/main/src/QuantumSdk/README.md). diff --git a/src/QuantumSdk/README.md b/src/QuantumSdk/README.md index 26501c5c4e..acc2ef9c77 100644 --- a/src/QuantumSdk/README.md +++ b/src/QuantumSdk/README.md @@ -32,7 +32,7 @@ Any project that uses the Quantum Sdk can easily incorporate custom compilation ``` Marking all assets as private by adding a `PrivateAssets="All"` attribute is generally a good practice if the reference is a development only dependency, which is often the case for assemblies that implement rewrite steps. -A custom compilation step is defined by a class that implements the [IRewriteStep interface](https://github.com/microsoft/qsharp-compiler/blob/master/src/QsCompiler/Compiler/PluginInterface.cs). The output assembly of a project reference or any .NET Core library contained in a package reference marked as qsc reference is loaded during compilation and searched for classes implementing the `IRewriteStep` interface. Any such class is instantiated using the default constructor, and the implemented transformation is executed. +A custom compilation step is defined by a class that implements the [IRewriteStep interface](https://github.com/microsoft/qsharp-compiler/blob/main/src/QsCompiler/Compiler/PluginInterface.cs). The output assembly of a project reference or any .NET Core library contained in a package reference marked as qsc reference is loaded during compilation and searched for classes implementing the `IRewriteStep` interface. Any such class is instantiated using the default constructor, and the implemented transformation is executed. [comment]: # (TODO: add a section detailing the IRewriteStep interface, and link it here) @@ -47,7 +47,7 @@ Steps defined within packages or projects with higher priority are executed firs [comment]: # (TODO: describe how to limit included rewrite steps to a particular execution target) -An example for defining custom compilation steps in a referenced .NET Core project can be found [here](https://github.com/microsoft/qsharp-compiler/tree/master/examples). +An example for defining custom compilation steps in a referenced .NET Core project can be found [here](https://github.com/microsoft/qsharp-compiler/tree/main/examples). See the [this section](#packaging) for more detail on how to package a Q# compiler extension to distribute it as a NuGet package. @@ -92,7 +92,7 @@ The content of the file should be similar to the following, with `Package_Name` ``` -This [example](https://github.com/microsoft/qsharp-compiler/tree/master/examples/CompilerExtensions/ExtensionPackage) provides a template for packaging a Q# compiler extension. +This [example](https://github.com/microsoft/qsharp-compiler/tree/main/examples/CompilerExtensions/ExtensionPackage) provides a template for packaging a Q# compiler extension. If you develop a NuGet package to extend the Q# compilation process, we recommend to distribute it as a self-contained package to avoid issues due to references that could not be resolved. Each qsc reference is loaded into its own context to avoid issues when several references depend on different versions of the same package.