[Assorted-commits] SF.net SVN: assorted: [617] zdb/trunk/README

[<yan...@us...>]

Revision: 617
          http://assorted.svn.sourceforge.net/assorted/?rev=617&view=rev
Author:   yangzhang
Date:     2008-03-06 23:32:09 -0800 (Thu, 06 Mar 2008)

Log Message:
-----------
added a readme

Added Paths:
-----------
    zdb/trunk/README

Added: zdb/trunk/README
===================================================================
--- zdb/trunk/README	                        (rev 0)
+++ zdb/trunk/README	2008-03-07 07:32:09 UTC (rev 617)
@@ -0,0 +1,43 @@
+Overview
+--------
+
+ZDB is an object database system that emphasizes semantics (naturally
+representing things).
+
+Requirements
+------------
+
+- [Scala Commons] 0.1
+
+[Scala Commons]: http://assorted.sf.net/scala-commons/
+
+Setup
+-----
+
+To build, run:
+
+  ./run.bash build
+
+Usage
+-----
+
+  ./run.bash file
+
+runs `zdb.FileIo`, which just loads the DB and dumps the name of every object
+to stdout.
+
+  ./run.bash web
+
+runs `zdb.WebUi`, which loads the DB and starts an HTTP server listening on
+port 8888. This serves a bookmarklet page at `http://localhost:8888/` for
+adding new objects that are bookmarks.
+
+Misc
+----
+
+I think the next step is to build a UI so that I can use this thing. UIs have
+to be ultra-easy to build, though, since there are going to be so many
+different views over ZDB. The first one to build should be a generic data
+maneger/explorer, which I barely started writing in `explorer.lzx`.
+
+I'll also provide a sample DB (my own) at some point.


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.