aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Bex <peter@more-magic.net>2011-05-26 22:57:21 +0200
committerPeter Bex <peter@more-magic.net>2011-05-26 22:57:21 +0200
commit667d2c341f14b73dea63bc18db83f0c378e21085 (patch)
treec1be3b657939f347ce981682a4acabe0c637a4c8
parent8c354ca51c685a3df503265ca83f4b5250514383 (diff)
downloadpseudo-meta-egg-info-667d2c341f14b73dea63bc18db83f0c378e21085.tar.gz
Fully documented... hehe
-rw-r--r--README23
1 files changed, 23 insertions, 0 deletions
diff --git a/README b/README
index 51f6e21..cc14d53 100644
--- a/README
+++ b/README
@@ -3,6 +3,22 @@ automatically-generated release-info files and files-list files
(the latter of which serves as the files section of a meta-file)
for an SVN repository.
+It assumes the svn repository location contains subdirectories
+matching the names of eggs and those subdirectories contain a
+directory called "tags" with underneath it a directory for each
+revision, with the revision number as its name:
+
+ /MY-EGG
+ /tags
+ /1.0
+ /1.1
+ /ANOTHER-EGG
+ /tags
+ /0.1
+ /0.2
+ /1.0
+
+
You can use it like this:
(use spiffy spiffy-uri-match pseudo-meta-egg-info)
@@ -16,3 +32,10 @@ You can use it like this:
`(((/ "release-info") (GET ,release-info))
((/ "files-list") (GET ,files-list)))))))
(start-server)
+
+
+This makes the release-info for egg MY-EGG available under
+http://localhost:8080/release-info?egg=MY-EGG
+
+and the files-list for release 1.0 under
+http://localhost:8080/files-list?egg=MY-EGG;release=1.0