Skip to content
Permalink
Browse files

Update README and bump version for using prerelease feed. (#151)

* Update README and bump version for using prerelease feed.

* Added NuGet.Config file pointing to prerelease feed.

* Made README more explicit.
  • Loading branch information...
cgranade committed Aug 20, 2019
1 parent 9799612 commit 2f01908f8eed5e8fcacc8694543868c88256cd38
Showing with 54 additions and 5 deletions.
  1. +20 −0 NuGet.Config
  2. +33 −4 README.md
  3. +1 −1 build.yml
@@ -0,0 +1,20 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the MIT License. -->

<!--
This configuration tells the .NET Core SDK to build the libraries using the
Quantum Development Kit prerelease feed in addition to any other currently
configured NuGet feeds.
This allows us to use prerelease packages from other parts of the Quantum
Development Kit in between releases.
See https://docs.microsoft.com/en-us/nuget/consume-packages/configuring-nuget-behavior#how-settings-are-applied
for more information about how NuGet and the .NET Core SDK find package
sources from NuGet.Config files.
-->
<configuration>
<packageSources>
<add key="qdk-alpha" value="https://pkgs.dev.azure.com/ms-quantum-public/Microsoft Quantum (public)/_packaging/alpha/nuget/v3/index.json" protocolVersion="3" />
</packageSources>
</configuration>
@@ -5,19 +5,20 @@ Welcome to the Microsoft Quantum Development Kit!
This repository contains open-source libraries for the [Quantum Development Kit](https://docs.microsoft.com/en-us/quantum/?view=qsharp-preview):

- **[Docs/](./Docs)**: Additional documentation for developing on the libraries. Please see [QDK online documentation](https://docs.microsoft.com/quantum/) for online documentation.
- **[Canon/](./Canon)**: Q# sources used to implement [the canon](https://docs.microsoft.com/quantum/libraries/intro) portion of the Q# standard library.
- **[Standard/](./Standard)**: Q# sources used to implement [the Q# standard libraries](https://docs.microsoft.com/quantum/libraries/intro).
- **[Chemistry/](./Chemistry)**: Q# and C# sources used to implement a library for [quantum chemistry](https://docs.microsoft.com/quantum/libraries/chemistry) and Hamiltonian simulation.
- **[Numerics/](./Numerics)**: Q# sources used to implement the [quantum numerics library](https://docs.microsoft.com/quantum/libraries/numerics).
- **[LICENSE](./LICENSE.txt)**: Terms of use and license details for the Quantum Development Kit libraries.

## New to Quantum? ##

See the [introduction to quantum computing](https://docs.microsoft.com/quantum/quantum-concepts-1-intro) provided with the Quantum Development Kit.
See the [introduction to quantum computing](https://docs.microsoft.com/quantum/concepts/) provided with the Quantum Development Kit.

## Getting Started ##

The libraries provided in this repository are built using [.NET Core](https://docs.microsoft.com/en-us/dotnet/core/) and the
[Quantum Development Kit](https://docs.microsoft.com/en-us/quantum/?view=qsharp-preview).
Please see the [installation guide](https://docs.microsoft.com/quantum/quantum-installconfig) for how to get up and running.
Please see the [installation guide](https://docs.microsoft.com/quantum/install-guide) for how to get up and running.

You may also visit our [Quantum](https://github.com/Microsoft/Quantum) repository, which offers a wide variety
of samples on how to use these libraries to write quantum based programs.
@@ -26,7 +27,7 @@ of samples on how to use these libraries to write quantum based programs.

| branch | status |
|--------|-----------|
| master | [![Build Status](https://quarcsw.visualstudio.com/Libraries/_apis/build/status/Github/Libraries%20(GitHub))](https://quarcsw.visualstudio.com/Libraries/_build/latest?definitionId=62) |
| master | [![Build Status](https://dev.azure.com/ms-quantum-public/Microsoft%20Quantum%20(public)/_apis/build/status/Microsoft.QuantumLibraries?branchName=master)](https://dev.azure.com/ms-quantum-public/Microsoft%20Quantum%20(public)/_build/latest?definitionId=1&branchName=master) |

## Feedback ##

@@ -47,3 +48,31 @@ provided by the bot. You will only need to do this once across all repos using o
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

## [Optional] Using Prerelease Versions ##

If you're interested in helping test the Quantum Development Kit libraries, or if you want to try out new features before they are released, you can add the [Quantum Development Kit prerelease feed](https://dev.azure.com/ms-quantum-public/Microsoft%20Quantum%20(public)/_packaging?_a=feed&feed=alpha) to your .NET Core SDK configuration.
Packages on the prerelease feed are marked with `-alpha` in their version number, so that projects built using released versions of Quantum Development Kit libraries will not be affected.
Note that the prerelease feed is used automatically when building libraries in this repository.
To use the prerelease feed, edit your `NuGet.Config` file to include the prerelease feed URL (`https://pkgs.dev.azure.com/ms-quantum-public/Microsoft Quantum (public)/_packaging/alpha/nuget/v3/index.json`) as a package source.
The location of this file varies depending on your operating system:
| OS | NuGet config file location |
|----|----------------------------|
| Windows | `$Env:APPDATA/Roaming/NuGet/NuGet.Config` |
| macOS / Linux | `~/.config/NuGet/NuGet.Config` or `~/.nuget/NuGet/NuGet.Config` |
Note that this file may not already exist, depending on your configuration.
For example, the following `NuGet.Config` file includes both the main NuGet package feed, and the Quantum Development Kit prerelease feed:
```xml
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<packageSources>
<add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
<add key="qdk-alpha" value="https://pkgs.dev.azure.com/ms-quantum-public/Microsoft Quantum (public)/_packaging/alpha/nuget/v3/index.json" protocolVersion="3" />
</packageSources>
</configuration>
```
@@ -7,7 +7,7 @@ trigger:

variables:
Build.Major: 0
Build.Minor: 0
Build.Minor: 9
Drops.Dir: $(Build.ArtifactStagingDirectory)/drops

jobs:

0 comments on commit 2f01908

Please sign in to comment.
You can’t perform that action at this time.