Permalink
Browse files

formatting README.md

  • Loading branch information...
1 parent 12c0fbb commit 4e49199982e46f94ff2ba630934bc253ace8857f Jim Cortez committed May 23, 2012
Showing with 56 additions and 60 deletions.
  1. +56 −3 README.md
  2. +0 −57 README.txt
View
@@ -1,4 +1,57 @@
-ctv-devicecommunication-java
-============================
+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.
-Java Library Adapter for device communication development on Yahoo! Connected TV
+BUILD
+*****
+To create a jar for this library use Maven (http://maven.apache.org/). Use the command:
+
+ mvn package
+
+This will download all dependencies and create the jar file "target/device-control-<version>.jar".
+
+DOCUMENTATION
+*************
+If you wish to create documentation from the source use this command:
+
+ mvn "javadoc:javadoc"
+
+Generated documentation will be created in the doc/ folder. Open the doc/index.html file in your web browser.
+
+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/
+
+* org.json version 20090211
+(Java JSON Library)
+http://json.org/java/
+
+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/
+
+LICENSE
+*******
+The Yahoo! Connected TV Device Communication Java Library is licensed under the following BSD License.
+
+Software License Agreement (BSD License)
+Copyright c 2011 Yahoo! Inc. All rights reserved.
+
+Redistribution and use of this software in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+* 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.
+
+* 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.
View
@@ -1,57 +0,0 @@
-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
-*****
-To create a jar for this library use Maven (http://maven.apache.org/). Use the command:
-
- mvn package
-
-This will download all dependencies and create the jar file "target/device-control-<version>.jar".
-
-DOCUMENTATION
-*************
-If you wish to create documentation from the source use this command:
-
- mvn "javadoc:javadoc"
-
-Generated documentation will be created in the doc/ folder. Open the doc/index.html file in your web browser.
-
-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/
-
-* org.json version 20090211
-(Java JSON Library)
-http://json.org/java/
-
-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/
-
-LICENSE
-*******
-The Yahoo! Connected TV Device Communication Java Library is licensed under the following BSD License.
-
-Software License Agreement (BSD License)
-Copyright c 2011 Yahoo! Inc. All rights reserved.
-
-Redistribution and use of this software in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-* 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.
-
-* 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.

0 comments on commit 4e49199

Please sign in to comment.