summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorKevin Smith <git@kismith.co.uk>2012-10-16 12:57:04 (GMT)
committerGerrit Code Review <gerrit@localhost.localdomain>2012-10-16 14:42:48 (GMT)
commitd66758487de9cec5a0d3ca6380da2c3e22ab9ee2 (patch)
tree515d3a1db3413bea3f9d531c7be5171ef085fd7a /README
parent62344c6023bd07e7e96e30bbb9fca8ae8835f021 (diff)
downloadstroke-d66758487de9cec5a0d3ca6380da2c3e22ab9ee2.zip
stroke-d66758487de9cec5a0d3ca6380da2c3e22ab9ee2.tar.bz2
Update README with correct dependencies
Change-Id: Ic7f627d38318c352c7db057c2347d5e617f4078c
Diffstat (limited to 'README')
-rw-r--r--README15
1 files changed, 11 insertions, 4 deletions
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.