Home | History | Annotate | only in /external/smack/asmack-master
Up to higher level directory
NameDateSize
.gitignore01-Nov-201323
build.bash01-Nov-201313.3K
build.xml01-Nov-20132.6K
CHANGELOG01-Nov-2013482
jingle/01-Nov-2013
lib/01-Nov-2013
LICENSE01-Nov-201314.8K
local.properties.example01-Nov-201335
patch/01-Nov-2013
README.asmack01-Nov-20131.9K
README.markdown01-Nov-20133.2K
static-src/01-Nov-2013

README.asmack

      1 aSmack README
      2 =============
      3 
      4 Version: $VERSION_TAG
      5 Build date: $BUILD_DATE
      6 
      7 Important Notes
      8 ===============
      9 
     10 Read this, or aSmack won't work for you!
     11 
     12 Static Code
     13 -----------
     14 
     15 In order to work correctly on Android, you need to register Smack's
     16 XMPP Providers and Extensions manually and init some static code
     17 blocks before you doing any XMPP activty. Calling
     18 SmackAndroid.init(Context) (in org.jivesoftware.smack) will do this
     19 for you.
     20 
     21 ConnectionConfiguration
     22 -----------------------
     23 
     24 Please use the provided AndroidConnectionConfiguration class if
     25 possible to create a new connection.
     26 
     27 Compression
     28 -----------
     29 
     30 If you want compressed XMPP streams you have to add
     31 [jzlib-1.0.7](http://www.jcraft.com/jzlib/) to your project. Note that
     32 every version higher then 1.0.7 wont work.
     33 More Info: https://github.com/Flowdalic/smack/issues/12
     34 
     35 Problems / Debugging
     36 ==============================
     37 
     38 aSmack Wiki
     39 -----------
     40 
     41 More information about XMPP File Transfers, SSL Certificates and other
     42 stuff related to aSmack can be found in the wiki:
     43 https://github.com/Flowdalic/asmack/wiki
     44 
     45 How to debug your problem
     46 -------------------------
     47 
     48 We always provide source zips. Attach them to the jar in your favorite
     49 IDE. Enable debugging mode with [BOSH|XMPP]Connection.DEBUG and
     50 config.setDebug. See also:
     51 http://www.igniterealtime.org/builds/smack/docs/latest/documentation/debugging.html
     52 
     53 Reporting a bug
     54 ---------------
     55 
     56 Your issue should contain
     57 1. a logcat
     58 2. a server to reproduce
     59 3. the code you are using (for FOSS project we'll accept reposituroy URLs)
     60 
     61 If you record a logcat and make sure to remove your credentials
     62 (usually a base64 block inside <auth></auth>).
     63 
     64 There is no guarantee that we will reply immediatly. But we will try
     65 to investigate the problem. Feel free to join ##smack @ freenode and
     66 ask for help (you may have to idle for some time before you get a
     67 reply).
     68 
     69 Component Revision Information for this Release
     70 ===============================================
     71 
     72

README.markdown

      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 [![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 
     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 
    101