From d66758487de9cec5a0d3ca6380da2c3e22ab9ee2 Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Tue, 16 Oct 2012 13:57:04 +0100 Subject: Update README with correct dependencies Change-Id: Ic7f627d38318c352c7db057c2347d5e617f4078c diff --git a/Makefile b/Makefile index 30c97a4..57fc66b 100644 --- a/Makefile +++ b/Makefile @@ -41,3 +41,6 @@ third-party/icu4j.jar: mkdir -p third-party curl http://download.icu-project.org/files/icu4j/4.8.1/icu4j-4_8_1.jar -o third-party/icu4j.jar +.git/hooks/commit-msg: + curl -k https://git.swift.im/review/tools/hooks/commit-msg -o .git/hooks/commit-msg + chmod u+x .git/hooks/commit-msg diff --git a/README b/README index 185d10a..3aa671e 100644 --- a/README +++ b/README @@ -3,13 +3,20 @@ Stroke Stroke is a port of the C++ Swift library ( http://swift.im/swiften/ ) The source is available from the Git repository at http://swift.im/git/stroke/ -It depends on the XmlPullParser from http://www.extreme.indiana.edu/xgws/xsoap/xpp/mxp1/index.html. This is passed to Ant in the xpp-dir parameter. The passed folder should contain the XPP jar called xpp.jar (i.e. with no version numbering in the filename). +For XML parsing, Stroke depends on the Aalto XML Parser and the STAX2 API, from http://wiki.fasterxml.com/AaltoHome It also depends upon http://www.jcraft.com/jzlib/, which is passed to ant in the jzlib-dir parameter. The passed folder should contain a jar called jzlib.jar. -To build, run: -ant -Dxpp-dir=path/to/directory/containing/xpp -Djzlib-dir=path/to/directory/containing/jzlib +It also depends upon icu4j from http://site.icu-project.org/ + +To build, run: +ant -Dxpp-dir=third-party/xpp -Djzlib-dir=third-party/jzlib -Dicu4j-dir=third-party/ -Dstax2-dir=third-party/stax2/ -Daalto-dir=third-party/aalto/ +Changing the paths to the relevant paths for the dependencies on your system Easy version: -The included Makefile should, on Unixes with make/curl installed, grab the dependencies (once only) and build. \ No newline at end of file +The included Makefile should, on Unixes with make/curl installed, grab the dependencies (once only) and build. + + +For development: +If you want to commit changes to Stroke, first run `make .git/hooks/commit-msg` to download a script that will generate change-ids needed by our review system. -- cgit v0.10.2-6-g49f6