summaryrefslogtreecommitdiffstats
path: root/doc/install
diff options
context:
space:
mode:
Diffstat (limited to 'doc/install')
-rw-r--r--doc/install/prokit.mdwn76
1 files changed, 76 insertions, 0 deletions
diff --git a/doc/install/prokit.mdwn b/doc/install/prokit.mdwn
new file mode 100644
index 0000000..a9ad647
--- /dev/null
+++ b/doc/install/prokit.mdwn
@@ -0,0 +1,76 @@
+[[!meta title="Getting the ProteanOS Development Kit"]]
+
+[[←_Back_to_Installing_ProteanOS|doc/install]]
+
+The [[ProteanOS_Development_Kit|dev/prokit]], or prokit, is a software package
+for installing, managing, and developing ProteanOS systems. prokit enables you
+to install a ProteanOS system, run a ProteanOS shell and other commands, manage
+software packages on an installed ProteanOS system, and build packages for
+ProteanOS.
+
+Building and installing prokit is easy. Ensure you have a **make**(1) utility
+such as GNU Make installed. No C or C++ compiler or other development tools are
+necessary to build prokit.
+
+
+Downloading the ProteanOS Development Kit
+=========================================
+
+Download a released version of prokit from the files site by [HTTP][prokit-http]
+or [FTP][prokit-ftp], e.g.:
+
+ $ wget http://files.proteanos.com/pub/prokit/1.1.0/prokit-1.1.0.tar.gz
+ $ tar -xzf prokit-1.1.0.tar.gz
+ $ cd prokit-1.1.0/
+
+Or clone it from the [Git repository][prokit-git]:
+
+ $ git clone git://git.proteanos.com/prokit/prokit.git
+ $ cd prokit/
+
+[prokit-http]: http://files.proteanos.com/pub/prokit/
+[prokit-ftp]: ftp://files.proteanos.com/pub/prokit/
+[prokit-git]: http://git.proteanos.com/prokit/prokit.git/
+
+
+Building the ProteanOS Development Kit
+======================================
+
+Configure and build prokit:
+
+ $ ./configure
+ $ make
+
+Or, if you cloned the Git repository, run:
+
+ $ ./autogen.sh
+ $ make
+
+To build from the repository you'll need to have GNU Autoconf and Automake
+installed.
+
+
+Installing the ProteanOS Development Kit
+========================================
+
+It is recommended but not necessary that you install prokit to your system:
+
+ $ sudo make install
+
+Check that the installation was successful:
+
+ $ prokit version
+
+
+The ProteanOS Development Kit Manual
+====================================
+
+prokit comes with a manual, starting with the **prokit**(1) page:
+
+ $ man prokit
+
+Or, if you didn't install prokit, you can find the manual by running:
+
+ $ man man/prokit.1
+
+The manual is also available from the [[prokit_homepage|dev/prokit]].