Name | Date | Size | |
---|---|---|---|
.. | 24-Jul-2013 | 4 KiB | |
.gitignore | 24-Jul-2013 | 23 | |
build.bash | 24-Jul-2013 | 13.3 KiB | |
build.xml | 24-Jul-2013 | 2.6 KiB | |
CHANGELOG | 24-Jul-2013 | 482 | |
jingle/ | 24-Jul-2013 | 4 KiB | |
lib/ | 24-Jul-2013 | 4 KiB | |
LICENSE | 24-Jul-2013 | 14.8 KiB | |
local.properties.example | 24-Jul-2013 | 35 | |
patch/ | 24-Jul-2013 | 4 KiB | |
README.asmack | 24-Jul-2013 | 1.9 KiB | |
README.markdown | 24-Jul-2013 | 3.2 KiB | |
static-src/ | 24-Jul-2013 | 4 KiB |
README.asmack
1aSmack README 2============= 3 4Version: $VERSION_TAG 5Build date: $BUILD_DATE 6 7Important Notes 8=============== 9 10Read this, or aSmack won't work for you! 11 12Static Code 13----------- 14 15In order to work correctly on Android, you need to register Smack's 16XMPP Providers and Extensions manually and init some static code 17blocks before you doing any XMPP activty. Calling 18SmackAndroid.init(Context) (in org.jivesoftware.smack) will do this 19for you. 20 21ConnectionConfiguration 22----------------------- 23 24Please use the provided AndroidConnectionConfiguration class if 25possible to create a new connection. 26 27Compression 28----------- 29 30If you want compressed XMPP streams you have to add 31[jzlib-1.0.7](http://www.jcraft.com/jzlib/) to your project. Note that 32every version higher then 1.0.7 wont work. 33More Info: https://github.com/Flowdalic/smack/issues/12 34 35Problems / Debugging 36============================== 37 38aSmack Wiki 39----------- 40 41More information about XMPP File Transfers, SSL Certificates and other 42stuff related to aSmack can be found in the wiki: 43https://github.com/Flowdalic/asmack/wiki 44 45How to debug your problem 46------------------------- 47 48We always provide source zips. Attach them to the jar in your favorite 49IDE. Enable debugging mode with [BOSH|XMPP]Connection.DEBUG and 50config.setDebug. See also: 51http://www.igniterealtime.org/builds/smack/docs/latest/documentation/debugging.html 52 53Reporting a bug 54--------------- 55 56Your issue should contain 571. a logcat 582. a server to reproduce 593. the code you are using (for FOSS project we'll accept reposituroy URLs) 60 61If you record a logcat and make sure to remove your credentials 62(usually a base64 block inside <auth></auth>). 63 64There is no guarantee that we will reply immediatly. But we will try 65to investigate the problem. Feel free to join ##smack @ freenode and 66ask for help (you may have to idle for some time before you get a 67reply). 68 69Component Revision Information for this Release 70=============================================== 71 72
README.markdown
1aSmack - buildsystem for Smack on Android 2========================================= 3 4*This repository doesn't contain much code, it's a build environment!* 5 6Tracking trunk can be hard. Doing massive changes on top of trunk can 7be near impossible. We are mixing 6 open source projects to provide a 8working xmpp library for Android. All trunk-based. 9 10This repository contains a source fetching, patching and building 11script. As well as all the minor changes to make an Android version 12fly. See the patches/ folder for a detailed list of changes and 13scripts. 14 15Compiled JARs 16============= 17 18Can be found @ http://asmack.freakempire.de/ 19 20Make sure to [*read the 21README*](https://github.com/Flowdalic/asmack/blob/master/README.asmack) 22for every release. 23 24Support 25======= 26[![Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=Flowdalic&url=https://github.com/flowdalic/asmack&title=asmack&language=&tags=github&category=software) 27 28Compiling aSmack 29================ 30 311. copy local.properties.example to local.properties and set the 32Android SDK path (e.g. sdk-location=/opt/android-sdk-update-manager/ 33on a gentoo system) 34 352. Run build.bash 36 37aSmack uses a [special fork of 38smack](https://github.com/Flowdalic/smack). You can read about the 39results you will get when using one of the various branches provides 40in the 41[README](https://github.com/Flowdalic/smack/blob/master/README.markdown). 42 43Apps that use this fork of aSmack 44================================= 45- [GTalkSMS](http://code.google.com/p/gtalksms/) uses many features of Smack and XMPP on Android: 46 - File Transfer 47 - DNS SRV 48 - MUC 49 - Entity Caps 50 - and many more 51 52- [yaxim](https://github.com/ge0rg/yaxim) 53- your app? 54 55Contribution 56============ 57 58If possible, please base patches on smack, not on aSmack. You can use 59the 'upstream' branch from [smack @ 60github](https://github.com/Flowdalic/smack). Only in some cases the 61'master' branch should be used. 62 63If your code follows [Smack's contributor guidelines]( 64http://community.igniterealtime.org/docs/DOC-1984), is good documented 65and comes with some testcases, then it's possible to commit it 66upstream. Simply join ##smack @ freenode and ask for a code review. 67 68Contributors 69============ 70 71We do not keep a seperate CONTRIBUTORS file, and we discourage @author 72tags. However you're free to add your full name to every git commit, 73and we will preserver this. Let us know if you've helped on 74non-technical stuff and we'll find a way to give you the deserved 75credit. 76 77Contact 78======= 79 80Join ##smack @ freenode 81 82Licences / Used libraries 83========================= 84 85We only accept Apache and BSD-like licences. 86We are currently using code from 87 88 * Apache Harmony (sasl/xml) (Apache Licence) 89 * smack (xmpp) (Apache Licence) 90 * novell-openldap-jldap (sasl) ([OpenLDAP Licence][1]) 91 * Apache qpid (sasl) (Apache Licence) 92 * jbosh (BOSH) (Apache Licence) 93 * dnsjava (dns srv lookups) (BSD) 94 * custom code (various glue stuff) (WTFPL | BSD | Apache) 95 96This should work for just about every project. Contact us if you have 97problems with the licence. 98 99 [1]: http://www.openldap.org/devel/cvsweb.cgi/~checkout~/LICENSE?rev=1.23.2.1&hideattic=1&sortbydate=0 "OpenLDAP Licence" 100 101