Skip to content
Newer
Older
100644 52 lines (34 sloc) 3 KB
0e09ddb Modifying the Readme and jar target
Jim Cortez authored May 23, 2012
1 # Overview
4e49199 formatting README.md
Jim Cortez authored May 23, 2012
2 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 May 23, 2012
3
0e09ddb Modifying the Readme and jar target
Jim Cortez authored May 23, 2012
4 # Build
4e49199 formatting README.md
Jim Cortez authored May 23, 2012
5 To create a jar for this library use Maven (http://maven.apache.org/). Use the command:
6
0e09ddb Modifying the Readme and jar target
Jim Cortez authored May 23, 2012
7 > mvn deploy
4e49199 formatting README.md
Jim Cortez authored May 23, 2012
8
0e09ddb Modifying the Readme and jar target
Jim Cortez authored May 23, 2012
9 This will download all dependencies and create the jar file "target/device-communcation.jar".
4e49199 formatting README.md
Jim Cortez authored May 23, 2012
10
0e09ddb Modifying the Readme and jar target
Jim Cortez authored May 23, 2012
11 # Documentation
4e49199 formatting README.md
Jim Cortez authored May 23, 2012
12 If you wish to create documentation from the source use this command:
13
0e09ddb Modifying the Readme and jar target
Jim Cortez authored May 23, 2012
14 > mvn "javadoc:javadoc"
4e49199 formatting README.md
Jim Cortez authored May 23, 2012
15
16 Generated documentation will be created in the doc/ folder. Open the doc/index.html file in your web browser.
17
0e09ddb Modifying the Readme and jar target
Jim Cortez authored May 23, 2012
18 # Libraries
4e49199 formatting README.md
Jim Cortez authored May 23, 2012
19 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.
20
21 * JmDNS version 3.4.0 (Apache 2.0 license)
0e09ddb Modifying the Readme and jar target
Jim Cortez authored May 23, 2012
22 * * (A mDNS client library)
23 * * http://jmdns.sourceforge.net/
4e49199 formatting README.md
Jim Cortez authored May 23, 2012
24
25 * org.json version 20090211
0e09ddb Modifying the Readme and jar target
Jim Cortez authored May 23, 2012
26 * * (Java JSON Library)
27 * * http://json.org/java/
4e49199 formatting README.md
Jim Cortez authored May 23, 2012
28
0e09ddb Modifying the Readme and jar target
Jim Cortez authored May 23, 2012
29 * For unit tests:
30 * * Junit version 4.8.2
31 * * * (Java testing library)
32 * * * http://junit.sourceforge.net/
4e49199 formatting README.md
Jim Cortez authored May 23, 2012
33
0e09ddb Modifying the Readme and jar target
Jim Cortez authored May 23, 2012
34 * * Hamcrest version 1.3.RC2
35 * * * (Java unit test helper library)
36 * * * http://code.google.com/p/hamcrest/
4e49199 formatting README.md
Jim Cortez authored May 23, 2012
37
0e09ddb Modifying the Readme and jar target
Jim Cortez authored May 23, 2012
38 # License
4e49199 formatting README.md
Jim Cortez authored May 23, 2012
39 The Yahoo! Connected TV Device Communication Java Library is licensed under the following BSD License.
40
41 Software License Agreement (BSD License)
42 Copyright c 2011 Yahoo! Inc. All rights reserved.
43
44 Redistribution and use of this software in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
45
46 * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
47
48 * 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.
49
50 * 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.
51
0e09ddb Modifying the Readme and jar target
Jim Cortez authored May 23, 2012
52 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.