summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoey Grover <joeygrover@gmail.com>2019-03-27 13:01:05 -0400
committerJoey Grover <joeygrover@gmail.com>2019-03-27 13:01:05 -0400
commitcef1cbb1e8a36d172bda93866c2160c64b01b9de (patch)
tree18f055a65bb586e5350b5b95f8f2d360d8ff2788
parent559faefbddb84ed82180c5b3c477e0ba7d845ccd (diff)
downloadsdl_android-cef1cbb1e8a36d172bda93866c2160c64b01b9de.tar.gz
Update main README
-rw-r--r--JavaSuiteFolderStructure.pngbin0 -> 18360 bytes
-rw-r--r--README.md33
2 files changed, 30 insertions, 3 deletions
diff --git a/JavaSuiteFolderStructure.png b/JavaSuiteFolderStructure.png
new file mode 100644
index 000000000..abe2729ea
--- /dev/null
+++ b/JavaSuiteFolderStructure.png
Binary files differ
diff --git a/README.md b/README.md
index 5d126e0f6..33c624aab 100644
--- a/README.md
+++ b/README.md
@@ -17,9 +17,11 @@ To understand if a contribution should be entered as an Android Pull Request (or
<a href="http://www.youtube.com/watch?feature=player_embedded&v=AzdQdSCS24M" target="_blank"><img src="http://i.imgur.com/nm8UujD.png?1" alt="SmartDeviceLink" border="10" /></a>
-## Mobile Proxy
+## Client Proxy
-The mobile library component of SDL is meant to run on the end user’s smart-device from within SDL enabled apps. The library allows the apps to connect to SDL enabled head-units and hardware through bluetooth, USB, and TCP. Once the library establishes a connection between the smart device and head-unit through the preferred method of transport, the two components are able to communicate using the SDL defined protocol. The app integrating this library project is then able to expose its functionality to the head-unit through text, media, and other interactive elements.
+The client libraries component of SDL is meant to run on the end user’s smart-device from within SDL enabled apps, as an embedded app, or connected to from the cloud. The libraries allows the apps to connect to SDL enabled head-units and hardware through bluetooth, USB, TCP for Android and cloud and embedded apps can connect through web sockets, Java Beans, and other custom transports. Once the library establishes a connection between the smart device and head-unit through the preferred method of transport, the two components are able to communicate using the SDL defined protocol. The app integrating this library project is then able to expose its functionality to the head-unit through text, media, and other interactive elements.
+
+# SmartDeviceLink Java Suite
## SmartDeviceLink Android
@@ -102,4 +104,29 @@ If you prefer making a JAR, simply call:
```sh
gradle build
```
-from within the project (JavaSE or JavaEE) and a JAR should be generated in the `build/libs` folder \ No newline at end of file
+from within the project (JavaSE or JavaEE) and a JAR should be generated in the `build/libs` folder
+
+## Java Suite Repo Structure
+
+![Java Suite Folder Structure](JavaSuiteFolderStructure.png)
+
+#### base Folder
+The base folder contains the source set that is shared between all of the compilable projects. This folder does not contain a a compilable project.
+
+#### baseAndroid Folder
+The baseAndroid folder contains symbolic links to files and folders from the base folder. This has been included since the Java Suite refactor is a minor version release and the base folder contains breaking changes for the Android project. This folder does not contain a a compilable project.
+
+#### android Folder
+The android folder contains the SDL Android library as well as the sample project for Android. Both of those are compilable projects.
+
+#### javaSE
+The javaSE folder contains the SDL JavaSE Library. The base folder source set is added as a dependency. This project can be used for embedded or remote SDL applications. It uses a web socket transport by default but can be made to work with other transports via the `CustomTransport`.
+
+###### JavaSE Sample App
+The JavaSE sample app is in the hello_sdl_java folder. It demonstrates an efficient way to structure a Java app using the JavaSE library.
+
+#### javaEE
+The javaEE folder contains the SDL JavaEE library. The JavaSE folder is used as a source set and added as a dependency. This library is based off the JavaSE library and will contain specifics for the JavaEe platform.
+
+###### JavaEE Sample App
+The JavaEE sample app is in the hello_sdl_java_ee folder. Most of the code is commented out since the library and sample app do not include the dependencies of JavaEE due to licensing issues. However, the commented out code demonstrates how to build a Java based app into the JavaEE bean architecture. \ No newline at end of file