Skip to content
This repository has been archived by the owner on Apr 16, 2019. It is now read-only.

Commit

Permalink
Modifying the Readme and jar target
Browse files Browse the repository at this point in the history
  • Loading branch information
Jim Cortez committed May 23, 2012
1 parent 4e49199 commit 0e09ddb
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 31 deletions.
45 changes: 20 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,41 @@
OVERVIEW
********
# Overview
The Yahoo! Connected TV Device Communication Java Library uses several 3rd party open source libraries and tools. This file summarizes the tools used, their purpose, and the licenses under which they are released. This file also explains how to build the jar file and generate Javadoc documentation.

BUILD
*****
# Build
To create a jar for this library use Maven (http://maven.apache.org/). Use the command:

mvn package
> mvn deploy
This will download all dependencies and create the jar file "target/device-control-<version>.jar".
This will download all dependencies and create the jar file "target/device-communcation.jar".

DOCUMENTATION
*************
# Documentation
If you wish to create documentation from the source use this command:

mvn "javadoc:javadoc"
> mvn "javadoc:javadoc"
Generated documentation will be created in the doc/ folder. Open the doc/index.html file in your web browser.

LIBRARIES
*********
# Libraries
Except as specifically stated below, the 3rd party software packages are not distributed as part of this project, but instead are separately downloaded from their respective provider and built on the developer's machine prior to building the library.

* JmDNS version 3.4.0 (Apache 2.0 license)
(A mDNS client library)
http://jmdns.sourceforge.net/
* * (A mDNS client library)
* * http://jmdns.sourceforge.net/

* org.json version 20090211
(Java JSON Library)
http://json.org/java/
* * (Java JSON Library)
* * http://json.org/java/

For unit tests:
* Junit version 4.8.2
(Java testing library)
http://junit.sourceforge.net/
* For unit tests:
* * Junit version 4.8.2
* * * (Java testing library)
* * * http://junit.sourceforge.net/

* Hamcrest version 1.3.RC2
(Java unit test helper library)
http://code.google.com/p/hamcrest/
* * Hamcrest version 1.3.RC2
* * * (Java unit test helper library)
* * * http://code.google.com/p/hamcrest/

LICENSE
*******
# License
The Yahoo! Connected TV Device Communication Java Library is licensed under the following BSD License.

Software License Agreement (BSD License)
Expand All @@ -54,4 +49,4 @@ Redistribution and use of this software in source and binary forms, with or with

* Neither the name of Yahoo! Inc. nor the names of Yahoo! Connected TV's contributors may be used to endorse or promote products derived from this software without specific prior written permission of Yahoo! Inc.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
12 changes: 6 additions & 6 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@
http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.yahoo.connectedtv</groupId>
<artifactId>device-control</artifactId>
<name>Yahoo! Connected TV Device Control</name>
<version>1001.1.17</version>
<artifactId>device-communication</artifactId>
<name>Yahoo! Connected TV Device Communication</name>
<version>1.1.1</version>
<url>http://connectedtv.yahoo.com</url>
<inceptionYear>2011</inceptionYear>
<developers>
<developer>
<id>jecortez</id>
<name>Jim Cortez</name>
<email>tvwidgets@yahoo.com</email>
<email>connectedtv@yahoo-inc.com</email>
<url>http://connectedtv.yahoo.com</url>
<organization>Yahoo!</organization>
<organizationUrl>http://yahoo.com</organizationUrl>
Expand All @@ -28,7 +28,7 @@
<build>
<sourceDirectory>src</sourceDirectory>
<testSourceDirectory>tests</testSourceDirectory>
<finalName>device-control</finalName>
<finalName>device-communication</finalName>
<plugins>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
Expand All @@ -45,7 +45,7 @@
<destDir>doc</destDir>
<overview>${basedir}/src/overview.html</overview>
<author>false</author>
<bottom> <![CDATA[Copyright 2011, <a href="
<bottom> <![CDATA[Copyright 2012, <a href="
http: /
www.yahoo.com ">
Yahoo!, Inc.
Expand Down

0 comments on commit 0e09ddb

Please sign in to comment.