> For the complete documentation index, see [llms.txt](https://hrodebert.gitbook.io/qic-database-ver-1.0.0/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hrodebert.gitbook.io/qic-database-ver-1.0.0/getting-started/install.md).

# Install

## Installation

### Prerequisites

Before you begin, make sure you have the following:

* **Compiler:** A C++ compiler with support for C++17 or later.
* **Dependencies:** The HBZPack library for handling compression and decompression.
* **Permissions:** Sufficient access to create, modify, and manage files and directories on your system.

### Installation Steps

1. **Download the Library**\
   Clone or download the Q.I.C repository from GitHub. Ensure your project directory includes the `qic.h` file and its dependencies.

   ```bash
   git clone https://github.com/your-repository/qic-library.git
   ```
2. **Include the Header File** Add the Q.I.C header file to your project and include it in your source code:

```
#include "qic.h"
```

**Link Dependencies** When compiling your project, ensure the [HBZPack](https://github.com/Hrodebert17/HBZPack) library is properly linked. For example, using `g++`:

```
g++ -o app main.cpp -Ilibs/HBZPack -Llibs/HBZPack -lHBZPack -std=c++17
```
