From 1935039432113a7437c19066d8129164bb73c7f2 Mon Sep 17 00:00:00 2001
From: Florian Schmaus
Date: Thu, 31 Jul 2014 19:45:00 +0200
Subject: [PATCH] Improve documentation (targetCompatibility, XPP3)
---
build.gradle | 3 ++-
documentation/gettingstarted.html | 6 ++----
resources/releasedocs/README.html | 19 ++++++++++++++-----
3 files changed, 18 insertions(+), 10 deletions(-)
diff --git a/build.gradle b/build.gradle
index 04e1875c7..79b7392da 100644
--- a/build.gradle
+++ b/build.gradle
@@ -23,6 +23,7 @@ allprojects {
}
group = 'org.igniterealtime.smack'
sourceCompatibility = 1.7
+ targetCompatibility = sourceCompatibility
version = shortVersion
if (isSnapshot) {
version += '-SNAPSHOT'
@@ -81,7 +82,7 @@ import org.apache.tools.ant.filters.ReplaceTokens
task prepareReleasedocs(type: Copy) {
from 'resources/releasedocs'
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]) {
diff --git a/documentation/gettingstarted.html b/documentation/gettingstarted.html
index ee5c35273..de817b244 100644
--- a/documentation/gettingstarted.html
+++ b/documentation/gettingstarted.html
@@ -23,10 +23,8 @@ important classes and concepts.
JAR Files and Requirements
-Smack is meant to be easily embedded into any existing JDK 1.5 or later Java application.
-It has no external dependencies (except for the Jingle voice chat functionality) and is optimized
-to be as small as possible. The library ships as several JAR files to provide more flexibility
-over which features applications require:
+Smack is meant to be easily embedded into any existing Java application.
+The library ships as several JAR files to provide more flexibility over which features applications require:
- smack-core.jar -- provides core XMPP functionality. All XMPP features that are
diff --git a/resources/releasedocs/README.html b/resources/releasedocs/README.html
index d1a220e4c..962c43fbc 100644
--- a/resources/releasedocs/README.html
+++ b/resources/releasedocs/README.html
@@ -154,18 +154,27 @@ hr {
-Thank you for downloading Smack!
-
+Thank you for downloading Smack! This version of Smack is compatible
+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 Xml
+Pull Parser 3rd Edition (XPP3) library or any other library that
+implements the XmlPullParser interface
+(like kXML).
+
+
Start off by viewing the documentation
that can be found in the "documentation" directory included with this distribution.
-
+
Further information can be found on the
Smack website. If you need help using or would like to make contributions or
fixes to the code, please visit the
online forum.
-
-About the Distribution
+
+
+About the Distribution
The smack-core.jar file in the main distribution folder. The optional
smack-extensions.jar contains the Smack extensions