finish todo item
[phorkie.git] / README.rst
index af8b42e51c195cb919c7c6d893aa129e8d2c64fb..3577d601db440ef1e895bdb19b3d62cffd0aec46 100644 (file)
@@ -12,11 +12,25 @@ Homepage: http://sourceforge.net/p/phorkie/
 Features
 ========
 - every paste is a git repository
+
+  - repositories can be cloned
+  - clone url can be displayed
 - paste editing
+
+  - add new files
+  - delete existing files
+  - replace file with upload
 - multiple files in one paste
 - syntax highlighting with GeSHi
 - rST rendering
+- image upload + display
+- external tool support
+
+  - xmllint
+  - php syntax check
+- history in the sidebar
 
+  - old files can be downloaded easily
 
 ============
 Dependencies
@@ -63,7 +77,7 @@ 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
+  $ ln -s /home/user/www/paste/repos/git /var/cache/git/paste
 
 Edit your ``config.php`` and set the ``$GLOBALS['phorkie']['cfg']['git']['public']``
 setting to ``git://$yourhostname/git/paste/``.
@@ -81,13 +95,15 @@ 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
+- tags
+- autotags for file types
+- Atom feed for new pastes
+- Atom feed for paste changes
 
 
 URLs
@@ -114,10 +130,13 @@ Internal directory layout
 ::
 
   repos/
-    1/ - git repository for paste #1
-      .git/
+    work/
+      1/ - work directory for paste #1
+      2/ - work directory for paste #2
+    git/
+      1.git/ - git repository for paste #1
         description - Description for the repository
-    2/ - git repository for paste #2
+      2.git/ - git repository for paste #2
 
 
 Search