tell people that the file name is optional

[phorkie.git] / README.rst

diff --git a/README.rst b/README.rst
index b7c357e35e5e0e738641b09eb7ccd7ece84e4f46..f5c7b789094989f46a78dfd770dd3236cda8905f 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -6,12 +6,16 @@ Pastes are editable, may have multiple files and are stored in git repositories.
 
 Homepage: http://sourceforge.net/p/phorkie/
 
+.. contents:: Table of Contents
 
 ========
 Features
 ========
 - every paste is a git repository
 - paste editing
+
+  - add new files
+  - delete existing files
 - multiple files in one paste
 - syntax highlighting with GeSHi
 - rST rendering
@@ -23,6 +27,13 @@ Dependencies
 phorkie stands on the shoulders of giants.
 
 
+Install VersionControl_Git
+==========================
+::
+
+  $ pear install versioncontrol_git-alpha
+
+
 Install GeSHi
 =============
 ::
@@ -42,6 +53,29 @@ Install Twig
   $ pear install twig/Twig
 
 
+=====
+HowTo
+=====
+
+Make git repositories clonable
+==============================
+To make git repositories clonable, you need to install ``git-daemon``
+(``git-daemon-run`` package on Debian/Ubuntu).
+
+Now make the repositories available by symlinking the paste repository
+directory (``$GLOBALS['phorkie']['cfg']['repos']`` setting) into
+``/var/cache/git``, e.g.::
+
+  $ ln -s /home/user/www/paste/repos /var/cache/git/paste
+
+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.
+
+
 =================
 Technical details
 =================