summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrettyWhite <geekman3454@protonmail.com>2019-03-12 10:59:08 -0400
committerBrettyWhite <geekman3454@protonmail.com>2019-03-12 10:59:08 -0400
commit6648ffc4e6937ca227a10d5765102112c12575ff (patch)
treec51d79cba5c6d6411494d6070cfe29d7c060dbde
parented59f1ff4f0a392105b59aee66a8fbe8926177b5 (diff)
downloadsdl_android-6648ffc4e6937ca227a10d5765102112c12575ff.tar.gz
add licenses and break up readme's
-rw-r--r--README.md39
-rw-r--r--android/README.md37
-rw-r--r--base/README.md6
-rw-r--r--base/src/main/java/android/os/AsyncTask.java18
-rw-r--r--base/src/main/java/android/os/Parcel.java18
-rw-r--r--base/src/main/java/android/os/Parcelable.java17
-rw-r--r--base/src/main/java/android/util/Log.java18
-rw-r--r--baseAndroid/README.md6
-rw-r--r--javaEE/README.md20
-rw-r--r--javaSE/README.md20
-rw-r--r--third_party.md (renamed from android/third_party.md)56
11 files changed, 249 insertions, 6 deletions
diff --git a/README.md b/README.md
index b5dad034e..5093a607d 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,8 @@ SmartDeviceLink (SDL) is a standard set of protocols and messages that connect a
* The [Core](https://github.com/smartdevicelink/sdl_core) component is the software which Vehicle Manufacturers (OEMs) implement in their vehicle head units. Integrating this component into their head unit and HMI based on a set of guidelines and templates enables access to various smartphone applications.
* The optional [SDL Server](https://github.com/smartdevicelink/sdl_server) can be used by Vehicle OEMs to update application policies and gather usage information for connected applications.
* The [iOS](https://github.com/smartdevicelink/sdl_ios) and [Android](https://github.com/smartdevicelink/sdl_android) libraries are implemented by app developers into their applications to enable command and control via the connected head unit.
-
+ * The [Embedded]() and [Cloud]() libraries, written in Java, are implemented by app developers into their applications to enable command and control to a connected head unit.
+
Pull Requests Welcome!
To understand if a contribution should be entered as an Android Pull Request (or issue), or an SDL Evolution Proposal, please reference [this document](https://github.com/smartdevicelink/sdl_evolution/blob/master/proposals_versus_issues.md).
@@ -56,4 +57,40 @@ Developers using Proguard to shrink and obfuscate their code should be sure to i
-keep class com.livio.** { *; }
# Video streaming apps must add the following line
-keep class ** extends com.smartdevicelink.streaming.video.SdlRemoteDisplay { *; }
+```
+
+## SmartDeviceLink Java
+
+### JavaSE
+
+The JavaSE project is meant to allow SDL compatibility for embedded applications.
+
+#### Dependency Managers
+
+To compile with the latest release of SDL JavaSE, include the following in your app's `build.gradle` file,
+
+```
+repositories {
+ jcenter()
+}
+dependencies {
+ implementation 'com.smartdevicelink:sdl_java_se:4.+'
+}
+```
+
+### JavaEE
+
+The JavaEE project is meant to allow SDL compatibility for web applications.
+
+#### Dependency Managers
+
+To compile with the latest release of SDL JavaEE, include the following in your app's `build.gradle` file,
+
+```
+repositories {
+ jcenter()
+}
+dependencies {
+ implementation 'com.smartdevicelink:sdl_java_ee:4.+'
+}
``` \ No newline at end of file
diff --git a/android/README.md b/android/README.md
new file mode 100644
index 000000000..3a281e8a6
--- /dev/null
+++ b/android/README.md
@@ -0,0 +1,37 @@
+## SmartDeviceLink Android
+
+We're still working on creating documentation for each of these individual repositories, but in the meantime, you can find more information about SmartDeviceLink [here](https://smartdevicelink.com)
+
+You can also find some branches that have yet to be merged into this GitHub project on the GENIVI page [here](http://git.projects.genivi.org/?p=smartdevicelink_android.git;a=summary).
+
+### Installation
+
+#### Dependency Managers
+
+To compile with the latest release of SDL Android, include the following in your app's `build.gradle` file,
+
+```
+repositories {
+ jcenter()
+}
+dependencies {
+ implementation 'com.smartdevicelink:sdl_android:4.+'
+}
+```
+
+For Maven or Ivy snippets please look at [Bintray](https://bintray.com/smartdevicelink/sdl_android/sdl_android)
+
+#### Manually
+
+If you prefer not to use any of the aforementioned dependency managers, you can integrate SDL Android into your project manually.
+
+### Proguard Rules
+
+Developers using Proguard to shrink and obfuscate their code should be sure to include the following lines in their proguard-rules.pro file:
+
+```
+-keep class com.smartdevicelink.** { *; }
+-keep class com.livio.** { *; }
+# Video streaming apps must add the following line
+-keep class ** extends com.smartdevicelink.streaming.video.SdlRemoteDisplay { *; }
+``` \ No newline at end of file
diff --git a/base/README.md b/base/README.md
new file mode 100644
index 000000000..151424381
--- /dev/null
+++ b/base/README.md
@@ -0,0 +1,6 @@
+## SmartDeviceLink Base
+
+The Base Java Folder holds classes that are commonly shared amongst the Android, JavaSE, and JavaEE projects.
+
+This should not be directly imported, please refer to the readme's of the JavaSE, JavaEE, or Android projects for installation instructions.
+
diff --git a/base/src/main/java/android/os/AsyncTask.java b/base/src/main/java/android/os/AsyncTask.java
index c5ee88d4b..b5ef5b726 100644
--- a/base/src/main/java/android/os/AsyncTask.java
+++ b/base/src/main/java/android/os/AsyncTask.java
@@ -1,5 +1,23 @@
package android.os;
+ /*
+ * Copyright (C) 2008 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * Note: This file has been modified from its original form.
+ */
+
public abstract class AsyncTask<Params, Progress, Result> {
diff --git a/base/src/main/java/android/os/Parcel.java b/base/src/main/java/android/os/Parcel.java
index 11a93ef79..2d6abc23f 100644
--- a/base/src/main/java/android/os/Parcel.java
+++ b/base/src/main/java/android/os/Parcel.java
@@ -1,5 +1,23 @@
package android.os;
+/*
+ * Copyright (C) 2006 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * Note: This file has been modified from its original form.
+ */
+
public class Parcel {
public void writeInt(int data){
diff --git a/base/src/main/java/android/os/Parcelable.java b/base/src/main/java/android/os/Parcelable.java
index c648a2718..9a3e5a23f 100644
--- a/base/src/main/java/android/os/Parcelable.java
+++ b/base/src/main/java/android/os/Parcelable.java
@@ -1,5 +1,22 @@
package android.os;
+/*
+ * Copyright (C) 2006 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * Note: This file has been modified from its original form.
+ */
public interface Parcelable {
diff --git a/base/src/main/java/android/util/Log.java b/base/src/main/java/android/util/Log.java
index 501567255..66ea1608e 100644
--- a/base/src/main/java/android/util/Log.java
+++ b/base/src/main/java/android/util/Log.java
@@ -1,5 +1,23 @@
package android.util;
+ /*
+ * Copyright (C) 2006 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * Note: This file has been modified from its original form.
+ */
+
public class Log {
diff --git a/baseAndroid/README.md b/baseAndroid/README.md
new file mode 100644
index 000000000..6ad99fef3
--- /dev/null
+++ b/baseAndroid/README.md
@@ -0,0 +1,6 @@
+## SmartDeviceLink BaseAndroid
+
+The Base Android folder symbolically links files used by the Android project that are in the Base folder.
+
+This folder does not need to be imported. Please refer to the installation instructions in the Android, JavaSE, or JavaEE readme's.
+
diff --git a/javaEE/README.md b/javaEE/README.md
new file mode 100644
index 000000000..65643b1be
--- /dev/null
+++ b/javaEE/README.md
@@ -0,0 +1,20 @@
+## SmartDeviceLink JavaEE
+
+The JavaEE project is meant to allow SDL compatibility for web applications.
+
+#### Dependency Managers
+
+To compile with the latest release of SDL JavaSE, include the following in your app's `build.gradle` file,
+
+```
+repositories {
+ jcenter()
+}
+dependencies {
+ implementation 'com.smartdevicelink:sdl_java_se:4.+'
+}
+```
+
+#### Manually
+
+Import the JAR file into your project. \ No newline at end of file
diff --git a/javaSE/README.md b/javaSE/README.md
new file mode 100644
index 000000000..4ed9d3c40
--- /dev/null
+++ b/javaSE/README.md
@@ -0,0 +1,20 @@
+## SmartDeviceLink JavaSE
+
+The JavaSE project is meant to allow SDL compatibility for embedded applications.
+
+#### Dependency Managers
+
+To compile with the latest release of SDL JavaSE, include the following in your app's `build.gradle` file,
+
+```
+repositories {
+ jcenter()
+}
+dependencies {
+ implementation 'com.smartdevicelink:sdl_java_se:4.+'
+}
+```
+
+#### Manually
+
+Import the JAR file into your project. \ No newline at end of file
diff --git a/android/third_party.md b/third_party.md
index 667e841a9..3cd05d512 100644
--- a/android/third_party.md
+++ b/third_party.md
@@ -1,4 +1,8 @@
-### SDL ANDROID
+### Introduction
+
+This file is broken into three Parts: SDL Base, SDL Android and SDL Java. SDL Android and SDL Java are sub projects of SDL Base. Additionally, SDL Java contains two sub-projects, SDL JavaSE and SDL JavaEE.
+
+## SDL BASE
Copyright (C) 2018 SmartDeviceLink Consortium, Inc.
@@ -26,14 +30,56 @@ original licenses.
The third party software included and used by this project is:
+**Android Open Source Project**
+
+* Copyright (C) 2006, 2008 & 2009 The Android Open Source Project
+* Licensed under Apache License, Version 2.0
+* The library is included in the MultiplexBluetoothTransport file
+* The classes AsyncTask, Parcel, Parcelable, and Log are also utilized in this project. These files HAVE BEEN MODIFIED from their original forms for use in this project. This message is in accordance with the Apache License, Version 2.0 section 4.b Redistribution.
+* See [https://services.gradle.org/distributions/gradle-4.4-all.zip](https://services.gradle.org/distributions/gradle-4.4-all.zip)
+
+## SDL ANDROID
+
+SDL Android inherits any license defined in SDL BASE.
+
+#### Third Party Licenses
+
+Both the source and binary distributions of this software contain
+some third party software. All the third party software included
+or linked is redistributed under the terms and conditions of their
+original licenses.
+
+The third party software included and used by this project is:
+
**Gradle 4.4**
* Licensed under Apache License, Version 2.0
* See [https://services.gradle.org/distributions/gradle-4.4-all.zip](https://services.gradle.org/distributions/gradle-4.4-all.zip)
-**Android 2009**
+## SDL Java
+
+### SDL JavaSE
+
+SDL JavaSE inherits any license defined in SDL BASE.
+
+#### Third Party Licenses
+
+Both the source and binary distributions of this software contain
+some third party software. All the third party software included
+or linked is redistributed under the terms and conditions of their
+original licenses.
+
+The third party software included and used by this project is:
+
+**Gradle 4.4**
-* Copyright (C) 2009 The Android Open Source Project
* Licensed under Apache License, Version 2.0
-* The library is included in the MultiplexBluetoothTransport file
-* See [https://services.gradle.org/distributions/gradle-4.4-all.zip](https://services.gradle.org/distributions/gradle-4.4-all.zip) \ No newline at end of file
+* See [https://services.gradle.org/distributions/gradle-4.4-all.zip](https://services.gradle.org/distributions/gradle-4.4-all.zip)
+
+
+### SDL JavaEE
+
+SDL JavaEE inherits any license defined in SDL JavaSE.
+
+
+