Merge branch 'milestone' of github.com:jnovack/phorkie into milestone
[phorkie.git] / README.rst
index e7e1625b6a3685421e3143078606c939999ed554..831c2f9ffcb6d7f2f9165f2b3950b7925619ba72 100644 (file)
@@ -68,9 +68,12 @@ Dependencies
 ============
 phorkie stands on the shoulders of giants.
 
-- git v1.7.5
-- php v5.3.0
-- pear v1.9.2
+It requires the following programs to be installed
+on your machine:
+
+- Git v1.7.5 or later
+- PHP v5.3.0 or later
+- PEAR v1.9.2 or later
 
 ::
 
@@ -91,10 +94,11 @@ phorkie stands on the shoulders of giants.
 
   $ pear channel-discover pear.michelf.ca
   $ pear install michelf/Markdown
-  
+
 Note that this version of GeSHi is a bit outdated, but it's the fastest
-way to install it.  If you install it manually be sure to update the
-path in ``data/config.default.php``.
+way to install it.
+If you install it manually be sure to update the
+path from ``data/config.default.php``.
 
 ======
 Search
@@ -152,19 +156,26 @@ Edit your ``config.php`` and set the ``$GLOBALS['phorkie']['cfg']['git']['public
 setting to ``git://$yourhostname/git/paste/``.
 The rest will be appended automatically.
 
+
 You're on your own to setup writable repositories.
 
+
 Protect your site with OpenID
 =============================
 You have the option of enabling OpenID authentication to help secure your
-pastes on phorkie.  Set the ``$GLOBALS['phorkie']['auth']`` values in the
+pastes on phorkie.
+Set the ``$GLOBALS['phorkie']['auth']`` values in the
 ``data/config.php`` file as desired.  
 
-There are two different types of security you can apply.  First, you can
-restrict to one of three ``securityLevels``; completely open (``0``), protection
-of write-enabled functions such as add, edit, etc. (``1``), and full site
-protection (``2``).  Additionally, you can restrict your site to ``listedUsersOnly``.
-You will need to add the individual OpenIDs identity urls to the
+There are two different types of security you can apply.
+First, you can restrict to one of three ``securityLevels``:
+
+- completely open (``0``)
+- protection of write-enabled functions such as add, edit, etc. (``1``)
+- full site protection (``2``)
+
+Additionally, you can restrict your site to ``listedUsersOnly``.
+You will need to add the individual OpenID urls to the
 ``$GLOBALS['phorkie']['auth']['users']`` variable.