Add README about how to get me going

1 files changed, 48 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..d0c747f
--- /dev/null
+++ b/README
@@ -0,0 +1,48 @@
+DIRS
+====
+
+dbgenerator: stuff to generate a pgo.db file
+template: the initial template contributed by cla
+web: web-frontend to the pgo.db file
+
+REQUIREMENTS
+============
+
+dbgenerator:
+------------
+- up-to-date portage tree
+  (non-unionfs'ed as it might give weird mtimes)
+- pkgcore 0.3.1 or later
+- python 2.5 with sqlite or python 2.4 with pysqlite2
+
+generation time:
+at the time of writing, on my box (3ghz p4, udma100 hdd, partly cluttered fs)
+db generation takes about 3 minutes
+
+frontend:
+---------
+CherryPy 3.0.2 or later
+Genshi 0.4.3 or later
+
+it can be used both standalone or together with mod_python
+
+GETTING IT GOING
+================
+
+1) Pick a box to get the db generated
+2) cd dbgenerator && python core.py
+
+pick up the resulting pgo.db file 
+
+4) move the db file so that it resides in the dir you run the CherryPy
+   controller from, in this example I'd recomment sticking it into
+   the dir of this README
+
+5) start CherryPy standalone:
+   PYTHONPATH=. python web/controller.py
+
+   this should give you something like
+   "HTTP Serving HTTP on http://0.0.0.0:8080/"
+
+6) now point a webbrowser at http://localhost:080/
+   and you should see the packages.gentoo.org site