vanitasvitae
/
Smack
mirror of https://github.com/vanitasvitae/Smack.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Improve documentation (targetCompatibility, XPP3)

This commit is contained in:
Florian Schmaus 2014-07-31 19:45:00 +02:00
parent 0b6069d75f
commit 1935039432
3 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
build.gradle
View File

@ -23,6 +23,7 @@ allprojects {
} }
group = 'org.igniterealtime.smack' group = 'org.igniterealtime.smack'
sourceCompatibility = 1.7 sourceCompatibility = 1.7
targetCompatibility = sourceCompatibility
version = shortVersion version = shortVersion
if (isSnapshot) { if (isSnapshot) {
version += '-SNAPSHOT' version += '-SNAPSHOT'
@ -81,7 +82,7 @@ import org.apache.tools.ant.filters.ReplaceTokens
task prepareReleasedocs(type: Copy) { task prepareReleasedocs(type: Copy) {
from 'resources/releasedocs' from 'resources/releasedocs'
into releasedocsDir into releasedocsDir
filter(ReplaceTokens, tokens: [version: version, releasedate: buildDate]) filter(ReplaceTokens, tokens: [version: version, releasedate: buildDate, targetCompatibility: targetCompatibility.toString()])
} }
task distributionZip(type: Zip, dependsOn: [javadocAll, prepareReleasedocs]) { task distributionZip(type: Zip, dependsOn: [javadocAll, prepareReleasedocs]) {

6
documentation/gettingstarted.html
View File

@ -23,10 +23,8 @@ important classes and concepts.
JAR Files and Requirements JAR Files and Requirements
</p> </p>
Smack is meant to be easily embedded into any existing JDK 1.5 or later Java application. Smack is meant to be easily embedded into any existing Java application.
It has no external dependencies (except for the Jingle voice chat functionality) and is optimized The library ships as several JAR files to provide more flexibility over which features applications require:
to be as small as possible. The library ships as several JAR files to provide more flexibility
over which features applications require:
<ul> <ul>
<li><tt>smack-core.jar</tt> -- provides core XMPP functionality. All XMPP features that are <li><tt>smack-core.jar</tt> -- provides core XMPP functionality. All XMPP features that are

19
resources/releasedocs/README.html
View File

@ -154,18 +154,27 @@ hr {
</table> </table>
<p> <p>
Thank you for downloading Smack! Thank you for downloading Smack! This version of Smack is compatible
<p> with JVMs @targetCompatibility@ or higher. If you dont' use a
dependency resolution system, like gradle or maven, then you will need
to download at least
the <a href="http://www.extreme.indiana.edu/xgws/xsoap/xpp/mxp1/">Xml
Pull Parser 3rd Edition (XPP3) library</a> or any other library that
implements the XmlPullParser interface
(like <a href="http://kxml.org/">kXML</a>).
</p>
<p>
Start off by viewing the <a href="documentation/index.html">documentation</a> Start off by viewing the <a href="documentation/index.html">documentation</a>
that can be found in the "documentation" directory included with this distribution. that can be found in the "documentation" directory included with this distribution.
<p> </p>
Further information can be found on the <a href="http://www.igniterealtime.org/projects/smack"> Further information can be found on the <a href="http://www.igniterealtime.org/projects/smack">
Smack website</a>. If you need help using or would like to make contributions or Smack website</a>. If you need help using or would like to make contributions or
fixes to the code, please visit the fixes to the code, please visit the
<a href="https://community.igniterealtime.org">online forum</a>. <a href="https://community.igniterealtime.org">online forum</a>.
</p>
<p><b>About the Distribution</b><p>
<p><b>About the Distribution</b></p>
The <tt>smack-core.jar</tt> file in the main distribution folder. The optional The <tt>smack-core.jar</tt> file in the main distribution folder. The optional
<tt>smack-extensions.jar</tt> contains the <a href="documentation/extensions/index.html">Smack extensions</a> <tt>smack-extensions.jar</tt> contains the <a href="documentation/extensions/index.html">Smack extensions</a>