changeset 56:b95d26ca1363

+ README
author Denis Ah-Kang <denis@w3.org>
date Fri, 30 Sep 2011 13:52:44 +0200
parents bb9b783c2f7c
children bcb0d5dd2b54
files README
diffstat 1 files changed, 60 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Fri Sep 30 13:52:44 2011 +0200
@@ -0,0 +1,60 @@
+pubrules-checker
+--------------------
+
+To get this:
+
+    hg clone http://dvcs.w3.org/hg/pubruleschecker
+    cd pubruleschecker
+    ./sbt
+    
+See http://mercurial.selenic.com/ for hg
+See https://github.com/harrah/xsbt/wiki for sbt
+
+
+This projectdepends on:
+* Java 6
+* that's all :-)
+
+It comes with
+* sbt project
+* generic sbt launcher
+* jar packager (assembly)
+* Web framework (Unfiltered)
+* embedded Web server (Jetty)
+
+How to start geeking
+--------------------
+
+BE PATIENT: the first time, some operations take some time because it downloads
+            all the dependencies...
+
+* to launch sbt
+
+$ ./sbt
+
+* to auto-compile the source
+
+> ~ compile
+
+* to run the Web App
+
+> run
+
+or
+
+> run 
+
+* to package the application as a stand-alone jar (creates target/read-write-web.jar)
+
+> assembly
+
+Using the stand-alone jar
+-------------------------
+
+Update the catalog:
+
+$ ./build-catalog.sh
+
+$ java -jar target/pubrules-checker.jar src/main/resources
+
+
Set up and maintained by W3C Systems Team, please report bugs to sysreq@w3.org.

W3C would like to thank Microsoft who donated the server that allows us to run this service.