ProjectsWebsiteBlog

Installation

Installing our library into your project

There are two ways to install our library into your project:

  • Using Visual Studio's NuGet package manager

  • Manual installation

Visual Studio's NuGet package manager

If you're using Visual Studio to build your project, it provides you an easy way to install NuGet packages, such as our libraries, into your project. This is easy and straightforward. In order to install a NuGet library to your project, follow the steps:

  1. Open Visual Studio to a project that you want to install our libraries to.

  2. Right click on either the project or the Dependencies entry beneath the project in the Solution Explorer pane and select Manage NuGet packages...

  3. Click on Browse and click on the Search text box. Then, write the desired library you'd like to install, such as Terminaux.

  4. Click on any of the libraries that show up in the search results, and click on Install.

  5. If any package asks for your acceptance of the license, read the license contained by clicking on their license names, then click on I Accept.

  6. The package is installed! Verify by expanding the Dependencies entry beneath the project and expanding the Packages entry.

Manual installation

If you'd like to manually install a NuGet package to a project with your favorite editor or if you're unable to use Visual Studio for some reason, you can use this installation method. However, this method comes in two ways:

  • Visual Studio

  • Text editor

Visual Studio

If you are using Visual Studio, follow these steps:

  1. Open Visual Studio to a project that you want to install our libraries to.

  2. Double click on the project as shown in the Solution Explorer pane

  3. Place this snippet at the end of the project file just before the </Project> designator (replace Terminaux with any other library and 5.3.0.1 with the desired version of the library)

    <ItemGroup>
  <PackageReference Include="Terminaux" Version="5.3.0.1" />
</ItemGroup>

  4. Save the project file. It should automatically install the required packages. If, however, the package restoration didn't automatically start, right-click on the solution and select Restore NuGet Packages.

Text editor

If you are using your favorite text editor, such as Visual Studio Code or Sublime Text, follow these steps:

  1. Open the file explorer and navigate to the target project directory that contains the project file (not the solution .sln file)

  2. Right-click on the project file -> Open With -> your favorite text editor

  3. Place this snippet at the end of the project file just before the </Project> designator (replace Terminaux with any other library and 5.3.0.1 with the desired version of the library)

    <ItemGroup>
  <PackageReference Include="Terminaux" Version="5.3.0.1" />
</ItemGroup>

  4. Save the project file. Then, open the terminal emulator in your preferred way and execute dotnet restore.

This also applies to terminal-based text editors, such as vim, though you'll have to open the terminal emulator beforehand in order to be able to use them.

Installing canary NuGet packages

Libraries and applications provide you a way to install canary NuGet packages, which get updated every time there is a commit or a pull request being pushed to the master and all available servicing branches. Those packages are pushed to our organization's GitHub Package Registry, which you can find here.

To install canary NuGet packages, refer to the below page to learn how to install canary NuGet packages from the registry:

LogoWorking with the NuGet registry - GitHub DocsGitHub Docs

Last updated