| Shuyi Chen | 8f4ce9e | 2013-05-22 13:10:40 -0700 | [diff] [blame] | 1 | aSmack - buildsystem for Smack on Android |
| 2 | ========================================= |
| 3 | |
| 4 | *This repository doesn't contain much code, it's a build environment!* |
| 5 | |
| 6 | Tracking trunk can be hard. Doing massive changes on top of trunk can |
| 7 | be near impossible. We are mixing 6 open source projects to provide a |
| 8 | working xmpp library for Android. All trunk-based. |
| 9 | |
| 10 | This repository contains a source fetching, patching and building |
| 11 | script. As well as all the minor changes to make an Android version |
| 12 | fly. See the patches/ folder for a detailed list of changes and |
| 13 | scripts. |
| 14 | |
| 15 | Compiled JARs |
| 16 | ============= |
| 17 | |
| 18 | Can be found @ http://asmack.freakempire.de/ |
| 19 | |
| 20 | Make sure to [*read the |
| 21 | README*](https://github.com/Flowdalic/asmack/blob/master/README.asmack) |
| 22 | for every release. |
| 23 | |
| 24 | Support |
| 25 | ======= |
| 26 | [](https://flattr.com/submit/auto?user_id=Flowdalic&url=https://github.com/flowdalic/asmack&title=asmack&language=&tags=github&category=software) |
| 27 | |
| 28 | Compiling aSmack |
| 29 | ================ |
| 30 | |
| 31 | 1. copy local.properties.example to local.properties and set the |
| 32 | Android SDK path (e.g. sdk-location=/opt/android-sdk-update-manager/ |
| 33 | on a gentoo system) |
| 34 | |
| 35 | 2. Run build.bash |
| 36 | |
| 37 | aSmack uses a [special fork of |
| 38 | smack](https://github.com/Flowdalic/smack). You can read about the |
| 39 | results you will get when using one of the various branches provides |
| 40 | in the |
| 41 | [README](https://github.com/Flowdalic/smack/blob/master/README.markdown). |
| 42 | |
| 43 | Apps 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 | |
| 55 | Contribution |
| 56 | ============ |
| 57 | |
| 58 | If possible, please base patches on smack, not on aSmack. You can use |
| 59 | the 'upstream' branch from [smack @ |
| 60 | github](https://github.com/Flowdalic/smack). Only in some cases the |
| 61 | 'master' branch should be used. |
| 62 | |
| 63 | If your code follows [Smack's contributor guidelines]( |
| 64 | http://community.igniterealtime.org/docs/DOC-1984), is good documented |
| 65 | and comes with some testcases, then it's possible to commit it |
| 66 | upstream. Simply join ##smack @ freenode and ask for a code review. |
| 67 | |
| 68 | Contributors |
| 69 | ============ |
| 70 | |
| 71 | We do not keep a seperate CONTRIBUTORS file, and we discourage @author |
| 72 | tags. However you're free to add your full name to every git commit, |
| 73 | and we will preserver this. Let us know if you've helped on |
| 74 | non-technical stuff and we'll find a way to give you the deserved |
| 75 | credit. |
| 76 | |
| 77 | Contact |
| 78 | ======= |
| 79 | |
| 80 | Join ##smack @ freenode |
| 81 | |
| 82 | Licences / Used libraries |
| 83 | ========================= |
| 84 | |
| 85 | We only accept Apache and BSD-like licences. |
| 86 | We 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 | |
| 96 | This should work for just about every project. Contact us if you have |
| 97 | problems 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 | |