README

1 files changed, 20 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..17c781c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# The **m**inimal **init**
+
+This is a simple program that just executes a command and halts the system after
+the command has finished executing.
+
+## But, why?
+
+I just needed a program that wouldn't exit on child exit that I could use as
+init for User-Mode Linux. If init exits, the Linux kernel panics, and I don't
+want extraneous call traces in my logs, not to mention that the terminal is left
+in a messy state if UM Linux panics.
+
+## Building
+
+It's just one simple file of C, so you can compile it any way you want.
+
+That said, I made a Makefile specifically to statically compile to a small
+binary that could be ran in any amd64 Linux, if that's what you need, and you
+what `make` it, then you also need the zig toolchain. It was just the best
+out-of-the-box option to statically compile a C binary.