Include java docs of the API classes. Generate separate assembly for …

…API.
jawi · Apr 12, 2011 · 48053e8 · 48053e8
1 parent 0a5e45b
commit 48053e8
Show file tree

Hide file tree

Showing 8 changed files with 511 additions and 193 deletions.
diff --git a/ols.distribution/AUTHOR b/ols.distribution/AUTHOR
@@ -1,6 +1,6 @@
-Modifications and additions made by:
-	J.W. Janssen, www.lxtreme.nl.
 
-Based on the original Sump sources made by:
-	Michael Poppitz, www.sump.org.
+Current maintenance, modifications and additions made by:
+	J.W. Janssen, <j dot w dot janssen at lxtreme.nl>, http://www.lxtreme.nl.
 
+Based on the original Sump sources made by:
+	Michael Poppitz, http://www.sump.org.
diff --git a/ols.distribution/README b/ols.distribution/README
@@ -1,16 +1,95 @@
 OpenBench LogicSniffer Client
 =============================
+J.W. Janssen, <j.w.janssen@lxtreme.nl>
 
-This is the client software for the OpenBench LogicSniffer (short name: ols) 
-written by J.W. Janssen.
 
-Based on the original Sump code base, this project aims at making the client
-more user-friendly, better to extend dynamically and better user experience.
+About
+-----
+This is the client software for the OpenBench LogicSniffer (short name: OLS) 
+written by Jan Willem Janssen.
 
-For more information about the hardware and software, see <http://ols.lxtreme.nl>
-and <http://dangerousprototypes.com/open-logic-sniffer>.
+Based on the original SUMP code base, this project aims at making the client
+more user-friendly, better to extend (dynamically) and better user experience.
 
-Drop me a line if you want to contribute code to the OLS repository, or need 
-any other form of help with this client.
+For more information about the hardware and software of the Open-Bench Logic
+Sniffer, see [1] and [2].
 
--- J.W. Janssen, <j dot w dot janssen at lxtreme.nl>
+
+Supported devices
+-----------------
+The current OLS client supports the following hardware:
+
+ - Open-Bench Logic Sniffer;
+ - Original SUMP-client;
+ - LogicShrimp;
+ - BusPirate;
+ - IRToy.
+
+In fact, all SUMP-compatible devices can be supported by the OLS client. To 
+add support for non-listed devices only a so-called "device profile" needs to
+be created. For more information on this, see [3].
+
+
+Prerequisites 
+-------------
+In order to run the OLS client, you need at least:
+
+ - a support operating system. Current supported are:
+   - Windows XP, Vista and 7, both 32- and 64-bit;
+   - Mac OSX (Intel only), both 32- and 64-bit;
+   - Linux, both 32- and 64-bit;
+   - Solaris, 32-bit only.
+   other platforms *might* work, but need some hacking in the OLS client 
+   itself;
+ - Java 6, see [4].
+
+
+Installation
+------------
+Installing the OLS client is a matter of unpacking the distribution archive, 
+and placing the resulting directory (with its contents) to a suitable 
+location. One thing to note is that the installation location needs to be 
+writable by the user running the client, as at runtime several (temporary)
+files are to be created.
+
+
+Running
+-------
+Running the OLS client is done by simply running either the 'run.bat' or 
+'run.sh' scripts located in the base directory of the installation. For Mac
+OSX, double clicking the application is sufficient. 
+
+
+Questions, suggestions and ideas
+--------------------------------
+If you have any questions, problems, bugs, suggestions and/or ideas about the
+OLS client, you can either mail me, or use the forums on [6] to post them. Be
+sure to also check out the FAQ on [5] to see whether your question might 
+already be answered.
+
+
+License
+-------
+The OLS client itself is released under GPLv2, see the LICENSE file for the 
+complete license. The OLS client software makes use of the OSGi specification,
+which is licensed under "OSGi Specification License, Version 1.0" [7], Apache 
+Felix, which is licensed under "Apache License, Version 2.0" [8] and JGoodies, 
+licensed under "BSD open source license" [9]. 
+
+
+External links
+--------------
+[1] <http://ols.lxtreme.nl>, the home page of the OLS client;
+[2] <http://dangerousprototypes.com/open-logic-sniffer>, the home page of the
+    OLS hardware;
+[3] <https://github.com/jawi/ols/wiki/OLS-Device-Profiles>, explains how the
+    OLS client can be extended for other devices;
+[4] <http://www.oracle.com/technetwork/java/index.html>, the home page where
+    Java 6+ can be downloaded;
+[5] <http://ols.lxtreme.nl/#FAQ>, provides some answers to frequently asked
+    questions;
+[6] <http://dangerousprototypes.com/forum/viewforum.php?f=23>, the forum for
+    the OLS hardware, with a subforum for the OLS client;
+[7] <http://www.osgi.org/Main/OSGiSpecificationLicense>;
+[8] <http://www.apache.org/licenses/LICENSE-2.0>;
+[9] <http://www.opensource.org/licenses/bsd-license.html>.
diff --git a/ols.distribution/api-assembly.xml b/ols.distribution/api-assembly.xml
@@ -0,0 +1,55 @@
+<assembly
+	xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">
+	<id>api</id>
+	<formats>
+		<format>zip</format>
+	</formats>
+	<dependencySets>
+		<dependencySet>
+			<outputDirectory>lib</outputDirectory>
+			<includes>
+				<include>nl.lxtreme.ols:api</include>
+				<include>nl.lxtreme.ols:util</include>
+				<include>nl.lxtreme.ols.tool:base</include>
+				<include>nl.lxtreme.ols:test.util</include>
+				<include>org.osgi:org.osgi.core</include>
+				<include>org.osgi:org.osgi.compendium</include>
+			</includes>
+		</dependencySet>
+	</dependencySets>
+	<fileSets>
+		<fileSet>
+			<directory>${project.basedir}/target/apidocs</directory>
+			<outputDirectory>javadoc</outputDirectory>
+			<useDefaultExcludes>true</useDefaultExcludes>
+			<includes>
+				<include>*-javadoc.jar</include>
+			</includes>
+			<fileMode>0644</fileMode>
+		</fileSet>
+		<fileSet>
+			<directory>${project.basedir}</directory>
+			<outputDirectory>/</outputDirectory>
+			<useDefaultExcludes>true</useDefaultExcludes>
+			<includes>
+				<include>AUTHOR*</include>
+				<include>README*</include>
+				<include>LICENSE*</include>
+				<include>install-to-maven.bat</include>
+			</includes>
+			<lineEnding>dos</lineEnding>
+		</fileSet>
+		<fileSet>
+			<directory>${project.basedir}</directory>
+			<outputDirectory>/</outputDirectory>
+			<useDefaultExcludes>true</useDefaultExcludes>
+			<includes>
+				<include>install-to-maven.sh</include>
+			</includes>
+			<lineEnding>unix</lineEnding>
+			<fileMode>0755</fileMode>
+		</fileSet>
+	</fileSets>
+</assembly>
diff --git a/ols.distribution/assembly.xml b/ols.distribution/assembly.xml
@@ -2,7 +2,7 @@
 	xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"
 	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 	xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">
-	<id>distribution</id>
+	<id>full</id>
 	<formats>
 		<format>zip</format>
 		<format>tar.gz</format>
@@ -25,15 +25,15 @@
 			</includes>
 			<lineEnding>keep</lineEnding>
 		</fileSet>
-        <fileSet>
-            <directory>${project.basedir}/src/main/profiles</directory>
-            <outputDirectory>plugins</outputDirectory>
-            <useDefaultExcludes>true</useDefaultExcludes>
-            <includes>
-                <include>*.cfg</include>
-            </includes>
-            <lineEnding>unix</lineEnding>
-        </fileSet>
+		<fileSet>
+			<directory>${project.basedir}/src/main/profiles</directory>
+			<outputDirectory>plugins</outputDirectory>
+			<useDefaultExcludes>true</useDefaultExcludes>
+			<includes>
+				<include>*.cfg</include>
+			</includes>
+			<lineEnding>unix</lineEnding>
+		</fileSet>
 		<fileSet>
 			<directory>${project.basedir}/doc</directory>
 			<outputDirectory>doc</outputDirectory>
@@ -51,6 +51,9 @@
 				<include>LICENSE*</include>
 				<include>*.bat</include>
 			</includes>
+			<excludes>
+				<exclude>install-to-maven.bat</exclude>
+			</excludes>
 			<lineEnding>dos</lineEnding>
 			<outputDirectory>/</outputDirectory>
 			<useDefaultExcludes>true</useDefaultExcludes>
@@ -60,6 +63,10 @@
 			<includes>
 				<include>*.sh</include>
 			</includes>
+			<excludes>
+				<exclude>app-bundle-osx.sh</exclude>
+				<exclude>install-to-maven.sh</exclude>
+			</excludes>
 			<lineEnding>unix</lineEnding>
 			<fileMode>0755</fileMode>
 			<outputDirectory>/</outputDirectory>

diff --git a/ols.distribution/install-to-maven.bat b/ols.distribution/install-to-maven.bat
@@ -0,0 +1,6 @@
+@echo off
+
+call mvn install:install-file -DgroupId=nl.lxtreme.ols -DartifactId=api -Dversion=1.0.4 -Dpackaging=jar -Dfile=lib/api-1.0.4.jar -Djavadoc=javadoc/api-1.0.4-javadoc.jar
+call mvn install:install-file -DgroupId=nl.lxtreme.ols -DartifactId=util -Dversion=1.0.5 -Dpackaging=jar -Dfile=lib/util-1.0.5.jar -Djavadoc=javadoc/util-1.0.5-javadoc.jar
+call mvn install:install-file -DgroupId=nl.lxtreme.ols -DartifactId=base -Dversion=1.0.0 -Dpackaging=jar -Dfile=lib/base-1.0.0.jar -Djavadoc=javadoc/base-1.0.0-javadoc.jar
+call mvn install:install-file -DgroupId=nl.lxtreme.ols -DartifactId=test.util -Dversion=1.0.0 -Dpackaging=jar -Dfile=lib/test.util-1.0.0.jar -Djavadoc=javadoc/test.util-1.0.0-javadoc.jar
diff --git a/ols.distribution/install-to-maven.sh b/ols.distribution/install-to-maven.sh
@@ -0,0 +1,6 @@
+#!/bin/sh
+
+mvn install:install-file -DgroupId=nl.lxtreme.ols -DartifactId=api -Dversion=1.0.4 -Dpackaging=jar -Dfile=lib/api-1.0.4.jar -Djavadoc=javadoc/api-1.0.4-javadoc.jar
+mvn install:install-file -DgroupId=nl.lxtreme.ols -DartifactId=util -Dversion=1.0.5 -Dpackaging=jar -Dfile=lib/util-1.0.5.jar -Djavadoc=javadoc/util-1.0.5-javadoc.jar
+mvn install:install-file -DgroupId=nl.lxtreme.ols -DartifactId=base -Dversion=1.0.0 -Dpackaging=jar -Dfile=lib/base-1.0.0.jar -Djavadoc=javadoc/base-1.0.0-javadoc.jar
+mvn install:install-file -DgroupId=nl.lxtreme.ols -DartifactId=test.util -Dversion=1.0.0 -Dpackaging=jar -Dfile=lib/test.util-1.0.0.jar -Djavadoc=javadoc/test.util-1.0.0-javadoc.jar