README: New file.

1 files changed, 44 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..c572b9b
--- /dev/null
+++ b/README
@@ -0,0 +1,44 @@
+Mini/Temporary ProteanOS Development Kit
+----------------------------------------
+
+This is miniprokit, a small and simple version of the ProteanOS
+Development Kit (which is not yet finished).
+
+miniprokit can install a ProteanOS system and run a ProteanOS shell
+within an isolated file system environment using the chroot utility.
+It is similar in function to the debootstrap program of Debian and
+derivatives.
+
+It requires superuser permission to run, as it uses the mount and chroot
+utilities.
+
+Installing a ProteanOS system can be done as follows (assuming use of
+sudo):
+
+    $ sudo ./miniprokit.sh install root
+
+To cross install another architecture, use the -a option (beware that
+only an architecture supported by your CPU can be installed and run),
+e.g.:
+
+    $ sudo ./miniprokit.sh install -a i686-linux-glibc root
+
+Platforms can be chosen using the -P option (though ProteanOS currently
+only provides the "dev" platform):
+
+    $ sudo ./miniprokit.sh install -P dev root
+
+Start a ProteanOS shell in an isolated file system environment as
+follows:
+
+    $ sudo ./miniprokit.sh shell root
+
+Copyright Information
+---------------------
+
+Copyright (C) 2014  Patrick "P. J." McDermott
+
+Copying and distribution of this file, with or without modification,
+are permitted in any medium without royalty provided the copyright
+notice and this notice are preserved.  This file is offered as-is,
+without any warranty.