docs: update README

Signed-off-by: Andrew Rynhard <[email protected]>
siderolabs · Oct 10, 2019 · 44ea13d · 44ea13d
1 parent 9499e56
commit 44ea13d
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+bin
diff --git a/README.md b/README.md
@@ -1 +1,15 @@
-# pkgs
+# pkgs
+
+This repository produces a set of packages that can be used to build a rootfs suitable for creating custom Linux distributions.
+The packages are published as a container image, and can be "installed" by simply copying the contents to your rootfs.
+For example, using Docker, we can do the following:
+
+```docker
+FROM scratch
+COPY --from=<registry>/<organization>/<pkg>:<tag> / /
+```
+
+## Resources
+
+- https://gcc.gnu.org/onlinedocs/gccint/Configure-Terms.html
+- https://wiki.osdev.org/Target_Triplet
diff --git a/bin/buildctl b/bin/buildctl
diff --git a/bin/gitmeta b/bin/gitmeta