libarc-validate/docs/introduction.md

40 lines
730 B
Markdown

# Introduction
[TOC]
libarc-validate is a unit-testing library for C++.
## Getting Started
libarc-validate uses the [build2][build2] build system, which is also the
only officially supported build system.
### 1. repositories.manifest
To get started, first add the libarc-validate repository to your
`repositories.manifest` file:
```
:
role: prerequisite
location: https://code.helloryan.se/arc/libarc-validate.git##HEAD
```
### 2. manifest
Then add `libarc-validate` as a dependency to your `manifest`-file:
```
depends: libarc-validate ^0.1.0-
```
### 3. buildfile
Finally, import and link your binaries with `libarc-validate`:
```
import libs =+ libarc-validate%lib{arc-validate}
```
[build2]: https://build2.org/