added README

1 files changed, 26 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..3f4af93
--- /dev/null
+++ b/README
@@ -0,0 +1,26 @@
+Required packages
+-----------------
+
+aptitude install python python-debian python-lzma curl python-jinja2 python-werkzeug sqlite3
+
+Create a database
+-----------------
+The database name is currently hardcoded as `test.sqlite3`. So copy the SQL
+statements from `importpkg.py` into `sqlite3 test.sqlite3`.
+
+Import packages
+---------------
+Import individual packages by feeding them to importpkg.py:
+
+    ls -t /var/cache/apt/archives/*.deb | while read f; echo $f; ./importpkg.py < $f || break; done
+
+Import a full mirror::
+
+    ./autoimport.py http://your.mirror.example/debian
+
+Viewing the results
+-------------------
+Run `./webapp.py` and enjoy a webinterface at `0.0.0.0:8800` or inspect the
+SQL database by hand. Example query:
+
+    SELECT a.package, a.filename, b.package, b.filename, a.size FROM content AS a JOIN content AS b ON a.hash = b.hash WHERE (a.package != b.package OR a.filename != b.filename) ORDER BY a.size DESC LIMIT 100;