update readme

[abchr.git] / README.MD

diff --git a/README.MD b/README.MD
index ba3f744d2b9cca30b986bafe15adbeb6b1454950..357a90f5cdcc7e7c8f0725f8f528dea48add1ecd 100644 (file)
--- 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.
       + 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
    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.
 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.