Click or drag to resize
Installation

This page describes the distribution process for releases of this library, and the installation process to enable your project to use the library features.

Distribution

Releases of this library are distributed through NuGet with the package ID TunnelVisionLabs.Net.UriTemplate. In addition to the release binaries, symbol files and source code are published to SymbolSource. By configuring Visual Studio (or another supported debugger) to use SymbolSource for debugging symbols, library users will be able to automatically step into the source code for this library if necessary during debugging.

Installation

Visual Studio 2012 and Newer

The easiest way to install NuGet packages in Visual Studio 2012 and newer is using the NuGet Package Manager extension for Visual Studio.

  1. Right click the top-level solution node in Solution Explorer and select Manage NuGet Packages for Solution...

  2. In the left pane, click the Online node and select nuget.org.

  3. In the search box in the top right, enter TunnelVisionLabs.Net.UriTemplate.

  4. In the search results, locate and select the TunnelVisionLabs.Net.UriTemplate package. Verify that the Id listed in the right hand pane is TunnelVisionLabs.Net.UriTemplate.

  5. Click the Install button. When the Select Projects window appears, check the box(es) for the projects in which you wish to reference the URI Template library. Note that if you ever need to make changes to this selection, you can follow these steps again but choose the Installed packages node in the left pane instead of the Online node.

Visual Studio 2010 Professional, Premium, or Ultimate

The commercial editions of Visual Studio 2010 are able to use the NuGet Package Manager extension for Visual Studio. For these editions, follow the same steps as Visual Studio 2012 and Newer, shown above.

Visual Studio 2010 Express Edition

The express editions of Visual Studio 2010 do not have access to the NuGet Package Manager extension for Visual Studio. Users with these editions must use the NuGet command line tools instead. Follow the same steps as users without Visual Studio, shown below.

Visual Studio 2008 and Earlier

The NuGet Package Manager extension for Visual Studio does not support Visual Studio 2008. Users with these versions must use the NuGet command line tools instead. Follow the same steps as users without Visual Studio, shown below.

Users without Visual Studio

The manual installation process describes file system paths containing references to several variables.

$(SolutionDir)

The path to your solution file if one is used; otherwise, the path to the root folder of your project structure.

$(Version)

The version of this library which is installed for the project. This version number is reported by the command line tool when the install command is executed.

$(Framework)

The version of the .NET Framework relevant to your library. Since the specific framework builds provided by this package could change over time, users are encouraged to choose from the contents available after the install command is executed.

The following steps describe the manual installation process for this package using the NuGet command line tool.

  1. Download the NuGet command line utility. The latest version of the utility is always available at this direct download address.

  2. Open a command line prompt to the directory where external libraries used by your project are stored. At this location, execute the following command. For the remaining steps, I'll assume the directory is $(SolutionDir)\lib.

    nuget.exe install TunnelVisionLabs.Net.UriTemplate

  3. In your project, add a reference to the following assembly.

    $(SolutionDir)\lib\TunnelVisionLabs.Net.UriTemplate-$(Version)\lib\$(Framework)\TunnelVisionLabs.Net.UriTemplate.dll