aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Weiske <cweiske@cweiske.de>2012-04-03 22:02:38 +0200
committerChristian Weiske <cweiske@cweiske.de>2012-04-03 22:02:38 +0200
commit6877f2d826b96990bf8df7e61aef7b419eab6854 (patch)
tree2aea192f19d568f88a9073a946a74526d7e80397
parentfe7c6f61e6ce6a18b3891bce5019b4785c3d4de7 (diff)
downloadphorkie-6877f2d826b96990bf8df7e61aef7b419eab6854.tar.gz
phorkie-6877f2d826b96990bf8df7e61aef7b419eab6854.zip
reorganize readme
-rw-r--r--README.rst82
1 files 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