From: sev <git@sev.monster>
Date: Wed, 3 Jan 2024 01:11:48 +0000 (-0600)
Subject: update readme
X-Git-Url: https://git.sev.monster/abchr.git/commitdiff_plain/fd849742d765091aa70f531d32d0f1b21a1b8b37?ds=sidebyside

update readme
---

diff --git a/README.MD b/README.MD
index ba3f744..357a90f 100644
--- a/README.MD
+++ b/README.MD
@@ -18,9 +18,17 @@ won't allow you to (easily) build for multiarch, but it works.
       + aports
     ```
 2. Clone the repo to the `bin` directory.
-3. Run `abchr-newchroot` to populate the `alpine` directory with a new
+3. Run `abchr-newchroot $(id -u)` 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.
+   for a build environment. It also creates a user in the chroot with its UID
+   set to the first argument of the script. Having this be your own UID is
+   optimal as it lets you manupulate the chroot files easily.
 4. To ensure everything worked, run `abchr abuild -h`. You should see the help
    text for `abuild`, which should be installed in the chroot.
+
+## Usage
+
+The `abchr` command simply sets up the chroot and starts whatever program is
+specified in the arguments as-is. There are some exceptions, meant for ease-of-
+use; run `abchr -h` to see what the script is capable of.