> For the complete documentation index, see [llms.txt](https://aptivi.gitbook.io/aptivi/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://aptivi.gitbook.io/aptivi/csharp-libraries/installation-and-upgrade/installation.md).

# Installation

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

* Using Visual Studio's NuGet package manager
* Manual installation

You can choose a way to install a package in a way you prefer.

***

## <mark style="color:$primary;">Visual Studio's NuGet package manager</mark>

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.

{% stepper %}
{% step %}

### <mark style="color:$primary;">Open your project</mark>

Open Visual Studio to a project that you want to install our libraries to.
{% endstep %}

{% step %}

### <mark style="color:$primary;">Open the NuGet package manager</mark>

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

<figure><img src="/files/jYyOXhXqsbs029nBn8Ki" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### <mark style="color:$primary;">Search for a library</mark>

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

<figure><img src="/files/ZazKv0jmnO7lmHXbeYEU" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### <mark style="color:$primary;">Install a library</mark>

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

<figure><img src="/files/rjQLhbOYHUyE57wGyj7j" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### <mark style="color:$primary;">Accept the license</mark>

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`.

<figure><img src="/files/5OLmpVa3DMFn4O6pZK8K" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### <mark style="color:$primary;">Verify the installation</mark>

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

<figure><img src="/files/Zqx8gLTEspn3y4a4jrTv" alt=""><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

***

## <mark style="color:$primary;">Manual installation</mark>

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

### <mark style="color:$primary;">Visual Studio</mark>

If you are using Visual Studio, follow these steps:

{% stepper %}
{% step %}

### <mark style="color:$primary;">Open your project</mark>

Open Visual Studio to a project that you want to install our libraries to.
{% endstep %}

{% step %}

### <mark style="color:$primary;">Open the project file</mark>

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

<figure><img src="/files/YZE9VcNzAHDgArunJzdY" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### <mark style="color:$primary;">Add a library reference</mark>

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

```xml
<ItemGroup>
  <PackageReference Include="Terminaux" Version="8.0.14" />
</ItemGroup>
```

{% endstep %}

{% step %}

### <mark style="color:$primary;">Save project and restore packages</mark>

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`.

<figure><img src="/files/E9zs98YDJk3q4eBoexMF" alt=""><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

### <mark style="color:$primary;">Text editor</mark>

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

{% stepper %}
{% step %}

### <mark style="color:$primary;">Open your project folder</mark>

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

<figure><img src="/files/rP6M3WCDN1Pklnl5lKHi" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### <mark style="color:$primary;">Open your text editor</mark>

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

<figure><img src="/files/DVVC9OTsKpIvj402WWVY" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### <mark style="color:$primary;">Add a library reference</mark>

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

```xml
<ItemGroup>
  <PackageReference Include="Terminaux" Version="8.0.14" />
</ItemGroup>
```

{% endstep %}

{% step %}

### <mark style="color:$primary;">Save project and restore packages</mark>

Save the project file. Then, open the terminal emulator in your preferred way and execute `dotnet restore`.
{% endstep %}
{% endstepper %}