Add readme

Signed-off-by: Timo Reichl <[email protected]>

README.md

@@ -0,0 +1,37 @@
+# Custom Void Linux repository
+
+This project represents my own custom Void Linux repository. It contains various XBPS packages for various architectures which didn't make the merge into the official [void-linux/void-packages](https://github.com/void-linux/void-packages) repository for one reason or another.
+
+To get an overview of the available packages, visit https://thetredev.github.io/voidlinux-repository.
+
+The entire repository is managed via GitHub Actions (see [`.github/workflows`](.github/workflows)) and custom container images (see the [Branches](#branches) section below). The only thing hidden from the public is my private RSA key which is used to sign the XBPS package repository.
+
+## How to install
+
+In order to install packages from this repository, create a new `.conf` file in the `/etc/xbps.d` directory containing the repository URL:
+```
+# /etc/xbps.d/99-thetredev.conf
+
+repository=https://thetredev.github.io/voidlinux-repository
+```
+
+Then, synchronize the XBPS repositories:
+```
+$ sudo xbps-install -S
+```
+
+XBPS will ask you to import my RSA key. **Double check** the correctness of the key:
+```
+Signed-by: Timo Reichl <[email protected]>
+Fingerprint: a9:e3:1f:07:e6:ff:c8:74:2a:f5:b6:22:5c:6d:d4:16
+```
+
+After importing the key, you can execute xbps-install xdeb-install to install the tool.
+
+## Branches
+
+| Branch | Purpose
+| --- | --- |
+| `main` | This branch. Used to build and release all XBPS packages listed within the [`packages`](./packages) directory. |
+| `docker` | Used to build and release custom container images to be able to easily build XBPS packages. |
+| `pages` | Locked placeholder branch to stop GitHub from executing the automatic GitHub Pages CI pipeline. The `main` branch contains a custom Pages CI pipeline. |