From: sev <git@sev.monster>
Date: Wed, 3 Jan 2024 01:01:19 +0000 (-0600)
Subject: add readme
X-Git-Url: https://git.sev.monster/abchr.git/commitdiff_plain/fb547c1216edee544bb06b7bb3510afb93085d66?ds=inline

add readme
---

diff --git a/README.MD b/README.MD
new file mode 100644
index 0000000..ba3f744
--- /dev/null
+++ b/README.MD
@@ -0,0 +1,26 @@
+# abchr
+
+There are various build chains surrounding Alpine. Most solutions use
+containerization, QEMU, and other technologies; meanwhile I just wanted a
+simple way to build packages and install development utilities without shitting
+up my production system. `abchr` is an attempt to create a simple solution to
+my simple problem. It isn't very flexible, requires root access for chroot, and
+won't allow you to (easily) build for multiarch, but it works.
+
+## Installation
+
+1. Create a directory and 3 subdirectories named `bin`, `alpine`, and `aports`.
+   Your tree should look like this:
+    ```
+    + abchr
+      + bin
+      + alpine
+      + aports
+    ```
+2. Clone the repo to the `bin` directory.
+3. Run `abchr-newchroot` to populate the `alpine` directory with a new
+   installation of Alpine Linux. This processes downloads the latest
+   `apk-tools-static` into the chroot and installs the basic packages necessary
+   for a build environment.
+4. To ensure everything worked, run `abchr abuild -h`. You should see the help
+   text for `abuild`, which should be installed in the chroot.