From 30d95d570c8accfae82afdf9a19f4e9c6c6e676e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Malte=20J=C3=BCrgens?= <maltejur@dismail.de>
Date: Mon, 6 Jun 2022 15:32:42 +0200
Subject: [PATCH] add readme

---
 README.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/README.md b/README.md
index e69de29..a7bf24a 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,36 @@
+# 🔨 bsys5
+
+This repo contains scripts and assets to build the
+[LibreWolf source tarball](https://gitlab.com/librewolf-community/browser/source)
+for various platforms with docker, as well as binary releases produced by those
+scripts.
+
+<a href="https://gitlab.com/librewolf-community/browser/bsys5/-/releases"><img src="https://img.shields.io/badge/%F0%9F%93%A5-Go to Releases-blue?style=flat" height="30px"></a>
+
+## <a id="targets"></a> Supported Targets
+
+| Platform        | x86_64                            | aarch64            |
+| --------------- | --------------------------------- | ------------------ |
+| Linux           |                                   |                    |
+| └─ Debian (deb) | ✅ (debian11)                     | -                  |
+| └─ Ubuntu (deb) | ✅ (ubuntu20, ubuntu21, ubuntu22) | -                  |
+| └─ Mint (deb)   | ✅ (mint20)                       | -                  |
+| └─ Fedora (rpm) | ✅ (fedora35, fedora36)           | -                  |
+| MacOS (dmg)     | ✅ (macos-x64_64)                 | ✅ (macos-aarch64) |
+| Windows         | _WIP_                             | -                  |
+
+## Running bsys5 Locally
+
+> Note: Bsys5 only works on Linux. Other platforms are cross-compiled from
+> Linux.
+
+To build LibreWolf with bsys5 locally, just install
+[Docker](https://docs.docker.com/engine/install/) and then clone this
+repository. Then you can just build the target you want with:
+
+`make <TARGET>`, for example `make ubuntu22`\
+(See [the above table](#targets) or `make help` for a list of supported targets.)
+
+This will pull a prebuilt build environment from
+[this repository](https://gitlab.com/librewolf-community/browser/bsys5/container_registry).
+If you also want to build that yourself, run `make docker-<TARGET>` first.