1 files changed, 51 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5ad1324
--- /dev/null
+++ b/README.md
@@ -0,0 +1,51 @@
+MuSlack
+=======
+
+MuSlack is an unoffical attempt at porting some
+[Slackware](https://www.slackware.com) current packages to statically built
+[musl](https://www.musl-libc.org) based ones.
+
+Auditing Changes
+----------------
+
+An easy way to audit the build scripts is to compare them to Slackware's
+official one.  To do this, copy the '.git' folder from this project into the
+root of Slackware-current and run 'git diff'.
+
+Requirements
+------------
+
+  - [bubblewrap](https://slackbuilds.org/repository/14.2/system/bubblewrap/)
+  - [musl libc](https://slackbuilds.org/repository/14.2/system/musl/)
+  - Slackware OS
+
+Building these Packages
+-----------------------
+
+To build the packages in this project, a locally installed MuSlack system is
+used under /opt/muslack.
+
+    export PATH=/bin:/sbin:$PATH:$(realpath ./cmd)
+    sudo mkdir /opt/muslack
+    sudo chown $USER /opt/muslack
+    
+    # Pull supporting package contents from Slackware
+    sync-files.sh
+
+    # Create _very_ minimal base system
+    init-env.sh
+
+    # Enter build environment
+    build-env.sh
+
+    # install kernel headers
+    (
+      cd /tmp
+      wget ftp://ftp.slackware.com/pub/slackware/slackware64-current/slackware64/d/kernel-headers-4.4.14-x86-1.txz
+      wget ftp://ftp.slackware.com/pub/slackware/slackware64-current/slackware64/d/kernel-headers-4.4.14-x86-1.txz.asc
+      gpg2 --verify-files *.asc
+      installpkg kernel-headers*.txz
+    )
+
+    # Try building + installing everything
+    build-all.sh