1 files changed, 41 insertions, 0 deletions
diff --git a/schema/browser/README.txt b/schema/browser/README.txt
new file mode 100644
index 00000000..45745b6d
--- /dev/null
+++ b/schema/browser/README.txt
@@ -0,0 +1,41 @@
+This is a demo application for browsing Baserock definitions.
+
+It is a tiny wrapper over the 'rdflib_web' Python library, which provides a
+really cool web interface for browsing RDF data, based on the Flask and RDFLib
+libaries.
+
+DISCLAIMER: this was hacked up in a few hours, please don't expect greatness.
+
+
+Deploying to Cloud Foundry
+--------------------------
+
+You can deploy to Pivotal Cloud Foundry by setting up an account at
+<https://run.pivotal.io>. Or you can deploy to another Cloud Foundry instance,
+probably. Make sure you have the `cf` commandline client installed and have run
+`cf login` with your details.
+
+You need to 'vendor' the dependencies by running:
+
+    mkdir vendor
+    pip install --download vendor -r requirements.txt
+
+You need to clone 'rdflib_web' from Git, because it isn't packaged in Pip.
+
+    git clone https://github.com/RDFLib/rdflib-web
+
+Finally you need to create the file 'definitions.rdfxml' from the definitions.
+
+    cd ../
+    python ./to-rdfxml.py
+    cd schema
+    mv ../definitions.rdfxml .
+
+Test the app locally.
+
+    PYTHONPATH=rdflib-web python main.py
+
+If it works, push to Cloud Foundry (10 second timeout, the default is probably
+too long):
+
+    cf push -t 10