From eca268ca1b41c88fec97c65217f5b3b390bec2ad Mon Sep 17 00:00:00 2001
From: josch <josch@pyneo.org>
Date: Tue, 15 Feb 2011 08:37:30 +0100
Subject: [PATCH] update readme

---
 README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 47 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 8a91188..3bace28 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,13 @@
 Hets Protege Plugin
 ===================
 
+Originating from an internship task, this now over 5200 lines big plugin
+allows protege to load, edit and save *.het files [rest2html][1].
+
+It still suffers from most exceptions to be only printed on standard output
+without a popup dialog informing the user of something going wrong so the
+plugin should still be run from the terminal.
+
 Installation
 ------------
 
@@ -9,16 +16,52 @@ It easily can be checked out from svn and compiled using this script:
 
 	#!/bin/sh -e
 
-	export PROTEGE_HOME=/home/josch/protege-hets/protege_home
-	mkdir -p $PROTEGE_HOME
-
 	svn checkout -q http://smi-protege.stanford.edu/repos/protege/protege4/protege-base/trunk protege-base
 	( cd protege-base; ant install; )
 
-	for i in org.protege.common org.protege.editor.core.application org.semanticweb.owl.owlapi org.protege.editor.owl org.protege.jaxb org.coode.owlviz; do
+	for i in org.protege.common \
+		 org.protege.editor.core.application \
+		 org.semanticweb.owl.owlapi \
+		 org.protege.editor.owl \
+		 org.protege.jaxb \
+		 org.coode.owlviz
+	do
 		svn checkout -q http://smi-protege.stanford.edu/repos/protege/protege4/plugins/$i/trunk $i
 		( cd $i; ant install; )
 	done
 
+For this and builds of the Hets Protege plugin to work an environment
+variable called $PROTEGE_HOME has to be set to the directory where
+protege should be/is installed.
+
+After having done that, the plugin can be compiled using ant:
+
+	ant
+
+Or can be compiled and run right away using:
+
+	ant run
+
+At all times $PROTEGE_HOME has to be set, so it makes sense to add it to
+your profile.d or similar.
+
+Usage
+-----
+
+To run protege,
+
+Features
+--------
+
+Missing Features
+----------------
+
+ * parsing *.het files containing view sections
+ * loading more than one *.het file at once
+
 Bugs
 ----
+
+ * hets interprets a tab as 8 spaces for its pp.xml output - have to work around that
+
+[1] http://www.informatik.uni-bremen.de/agbkb/forschung/formal_methods/CoFI/hets/index_e.htm