aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README32
1 files changed, 30 insertions, 2 deletions
diff --git a/README b/README
index 66170c3..3197524 100644
--- a/README
+++ b/README
@@ -1,3 +1,31 @@
-Piccast README
---------------
+PicCast Repo README
+-------------------
+
+./www/
+ Static content to be served up over HTTP (eg, stylesheets)
+
+./piccast/
+ Django application base directory
+
+./doc/
+ Project documentation
+
+./scripts/
+ Misc scripts
+
+
+Requirements
+-------------
+The django application requires:
+ - django 1.1
+ - python-docutils
+ - python 2.6+ (I think? with pysqlite or whatevah?)
+
+JSON API
+--------
+/json/feeds/
+/json/sets_by_feed/<feed_id>/
+/json/sets_by_feed/<feed_shortname>/
+/json/pics_by_set/<set_id>/
+