libarc-uri/docs/introduction.md
RYAN db13f767d2
All checks were successful
on-push / build-and-test (push) Successful in 19s
Prepare v0.2.0
2024-09-03 02:33:52 +02:00

40 lines
721 B
Markdown

# Introduction
[TOC]
libarc-uri is a library for parsing and manipulating Unique Resource Identifiers.
## Getting Started
libarc-uri 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-uri repository to your
`repositories.manifest` file:
```
:
role: prerequisite
location: https://code.helloryan.se/arc/libarc-uri.git##HEAD
```
### 2. manifest
Then add `libarc-uri` as a dependency to your `manifest`-file:
```
depends: libarc-uri ^0.2.0-
```
### 3. buildfile
Finally, import and link your binaries with `libarc-uri`:
```
import libs =+ libarc-uri%lib{arc-uri}
```
[build2]: https://build2.org/