From 6877f2d826b96990bf8df7e61aef7b419eab6854 Mon Sep 17 00:00:00 2001 From: Christian Weiske Date: Tue, 3 Apr 2012 22:02:38 +0200 Subject: [PATCH] reorganize readme --- README.rst | 82 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 57 insertions(+), 25 deletions(-) diff --git a/README.rst b/README.rst index 353664c..b7c357e 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,63 @@ ************************************ 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/ + + +======== +Features +======== +- every paste is a git repository +- paste editing +- multiple files in one paste +- syntax highlighting with GeSHi +- rST rendering + + +============ +Dependencies +============ +phorkie stands on the shoulders of giants. + + +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 + + +================= +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 ==== @@ -37,30 +94,5 @@ Search Use ``ack-grep`` -Install geshi -============= -:: - - $ pear channel-discover mediawiki.googlecode.com/svn - $ pear install mediawiki/geshi - - -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 -Features -======== -- every paste is a git repository -- rST rendering -- paste editing -- multiple files -- 2.30.2