remove filename label

[phorkie.git] / README.rst

diff --git a/README.rst b/README.rst
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..f5c7b789094989f46a78dfd770dd3236cda8905f 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -0,0 +1,132 @@
+************************************
+phorkie - PHP and Git based pastebin
+************************************
+Self-hosted pastebin software written in PHP.
+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
+
+
+============
+Dependencies
+============
+phorkie stands on the shoulders of giants.
+
+
+Install VersionControl_Git
+==========================
+::
+
+  $ pear install versioncontrol_git-alpha
+
+
+Install GeSHi
+=============
+::
+
+  $ pear channel-discover mediawiki.googlecode.com/svn
+  $ pear install mediawiki/geshi
+
+Note that this version of GeSHi is a bit outdated, but it's the fastest
+way to install it.
+
+
+Install Twig
+============
+::
+
+  $ pear channel-discover pear.twig-project.org
+  $ 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
+=================
+
+TODO
+====
+- search
+- OpenID-Login to get username+email as authorship information
+- sidebar: history
+- image upload
+- document how to keep disk usage low (block size)
+- comments
+- when 2 people edit, merge changes
+- diff changes
+- configurable highlights
+
+
+URLs
+====
+
+``/``
+  Index page. Shows form for new paste
+``/[0-9]+``
+  Display page for paste
+``/[0-9]/edit``
+  Edit the paste
+``/[0-9]+/raw/(.+)``
+  Display raw file contents
+``/[0-9]/delete``
+  Delete the paste
+``/search(/.+)?``
+  Search for term
+``/list(/[0-9])?``
+  List all pastes
+
+
+Internal directory layout
+=========================
+::
+
+  repos/
+    1/ - git repository for paste #1
+      .git/
+        description - Description for the repository
+    2/ - git repository for paste #2
+
+
+Search
+======
+Use ``ack-grep``
+
+
+
+