Swiftdiff options
| author | Alan Young <consult.awy@gmail.com> | 2015-07-06 08:14:13 (GMT) |
|---|---|---|
| committer | Kevin Smith <git@kismith.co.uk> | 2015-08-13 08:05:42 (GMT) |
| commit | 9bf162922691c1f45813da6a21f2e274bfad3114 (patch) | |
| tree | 2d7c49abc72ede17701c3300140718b1c3e81bcc /README.md | |
| parent | af3bb03053b9d83f4d38b31d66b292792206a327 (diff) | |
| download | stroke-9bf162922691c1f45813da6a21f2e274bfad3114.zip stroke-9bf162922691c1f45813da6a21f2e274bfad3114.tar.bz2 | |
VCard.getPhoto() to return null for absent photo.
Most of the time when VCard.getPhoto() is called it is only used to
determine presence or absence of a photo. Thus, it makes no sense to
allocate an empty ByteArray() just for this purpose. Return null
instead, if absent.
Change-Id: I3bae02ffbece5589c74c950bbb4c0db6c0376c76
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..ee28436 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# 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/ + +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. + +It also depends upon icu4j from http://site.icu-project.org/ + +It also depends upon dnsjava from http://www.dnsjava.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. + + +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. + +## Differences from Swiften + +Stroke tries to be a clean and accurate port of Swiften, in order to facilitate mirroring changes. Sometimes differences are either necessary or desirable. + +* `VCard.getPhoto()` returns null instead of an empty `ByteArray` when there is no photo. |