summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README24
1 files changed, 23 insertions, 1 deletions
diff --git a/README b/README
index 7f8f91d..dd36824 100644
--- a/README
+++ b/README
@@ -3,10 +3,32 @@ ProteanOS Development Kit
This is prokit, the ProteanOS Development Kit.
+prokit 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.
+
+After being built with configure and make, prokit can be installed to
+the system or run in place without installation.
+
+Installing a ProteanOS system can be done as follows (assuming use of
+sudo):
+
+ $ sudo src/prokit install trunk $root
+
+Start a ProteanOS shell in an isolated file system environment as
+follows:
+
+ $ sudo src/prokit shell $root
+
+For more information on prokit's commands, use the help command:
+
+ $ sudo src/prokit help
+
Copyright Information
---------------------
-Copyright (C) 2013 Patrick "P. J." McDermott
+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