Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 56 lines (36 sloc) 3.745 kb
0e09ddb Modifying the Readme and jar target
Jim Cortez authored
1 # Overview
b24497a @kelly-ireland Updated overview with DC high-level description
kelly-ireland authored
2 Yahoo! Connected TV’s Device Communication model enables new and exciting TV-viewing experiences driven by the sophisticated controls available on today’s tablets, laptops, and mobile phones. A new generation of TV App capabilities is now available to consumers, including gesture-based, multi-display, and multi-user features for intensive gaming, multimedia, and social applications.
3
4 This Device Communication platform supports two-way message-passing between Internet-enabled devices and connected TVs running the Yahoo! Connected TV Platform. Keyboard, navigation, and app-specific messages can be communicated through a new protocol over a local network.
5
4e49199 formatting README.md
Jim Cortez authored
6 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.
1be98ce @jimcortez Initial commit
jimcortez authored
7
0e09ddb Modifying the Readme and jar target
Jim Cortez authored
8 # Build
4e49199 formatting README.md
Jim Cortez authored
9 To create a jar for this library use Maven (http://maven.apache.org/). Use the command:
10
0e09ddb Modifying the Readme and jar target
Jim Cortez authored
11 > mvn deploy
4e49199 formatting README.md
Jim Cortez authored
12
0e09ddb Modifying the Readme and jar target
Jim Cortez authored
13 This will download all dependencies and create the jar file "target/device-communcation.jar".
4e49199 formatting README.md
Jim Cortez authored
14
0e09ddb Modifying the Readme and jar target
Jim Cortez authored
15 # Documentation
4e49199 formatting README.md
Jim Cortez authored
16 If you wish to create documentation from the source use this command:
17
0e09ddb Modifying the Readme and jar target
Jim Cortez authored
18 > mvn "javadoc:javadoc"
4e49199 formatting README.md
Jim Cortez authored
19
20 Generated documentation will be created in the doc/ folder. Open the doc/index.html file in your web browser.
21
0e09ddb Modifying the Readme and jar target
Jim Cortez authored
22 # Libraries
4e49199 formatting README.md
Jim Cortez authored
23 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.
24
25 * JmDNS version 3.4.0 (Apache 2.0 license)
0e09ddb Modifying the Readme and jar target
Jim Cortez authored
26 * * (A mDNS client library)
27 * * http://jmdns.sourceforge.net/
4e49199 formatting README.md
Jim Cortez authored
28
29 * org.json version 20090211
0e09ddb Modifying the Readme and jar target
Jim Cortez authored
30 * * (Java JSON Library)
31 * * http://json.org/java/
4e49199 formatting README.md
Jim Cortez authored
32
0e09ddb Modifying the Readme and jar target
Jim Cortez authored
33 * For unit tests:
34 * * Junit version 4.8.2
35 * * * (Java testing library)
36 * * * http://junit.sourceforge.net/
4e49199 formatting README.md
Jim Cortez authored
37
0e09ddb Modifying the Readme and jar target
Jim Cortez authored
38 * * Hamcrest version 1.3.RC2
39 * * * (Java unit test helper library)
40 * * * http://code.google.com/p/hamcrest/
4e49199 formatting README.md
Jim Cortez authored
41
0e09ddb Modifying the Readme and jar target
Jim Cortez authored
42 # License
4e49199 formatting README.md
Jim Cortez authored
43 The Yahoo! Connected TV Device Communication Java Library is licensed under the following BSD License.
44
45 Software License Agreement (BSD License)
bec4727 @kelly-ireland Updated copyright to current year
kelly-ireland authored
46 Copyright c 2012 Yahoo! Inc. All rights reserved.
4e49199 formatting README.md
Jim Cortez authored
47
48 Redistribution and use of this software in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
49
50 * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
51
52 * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
53
54 * 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.
55
0e09ddb Modifying the Readme and jar target
Jim Cortez authored
56 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.
Something went wrong with that request. Please try again.