initial checkin

git-svn-id: https://svn.spreadspace.org/flufigut/trunk@2 88d0365b-309c-4eec-8061-d8e0c04ad69e

1 files changed, 43 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..9403f81
--- /dev/null
+++ b/README
@@ -0,0 +1,43 @@
+Introduction
+============
+
+flufig is a simple flumotion configuration generator using
+pyhton jinja2 template engine and simplejson. flufig generates
+planet.xml and worker.xml files from configuration templates and
+a easy representation of the flow structure written in json.
+
+
+Dependencies
+============
+
+ python-jinja2
+ python-simplejson
+
+
+Installation/Usage
+==================
+
+Getting the source via subversion:
+----------------------------------
+
+svn co https://svn.spreadspace.org/flufig/trunk tcpproxy
+cd flufig/src
+
+Usage
+-----
+
+Edit templates to your needs, edit data.json containing your
+planet structure.
+
+# flufig.py <name> <data.json>
+
+The script expects planet.xml and worker.xml to be present in
+the directory ../templates/<name>/ and loads them as templates
+for manager and worker configuration files.
+All templates referenced by the master templates must reside
+inside ../templates/<name>/.
+
+data structure
+--------------
+
+tba...
\ No newline at end of file