summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJustin Dickow <jjdickow@gmail.com>2015-03-05 09:37:33 -0500
committerJustin Dickow <jjdickow@gmail.com>2015-03-05 09:37:33 -0500
commit16a885d3abd39d1129325bc7a91edba83ef3034e (patch)
tree9f395faef08705711ddd9431d78441adeb5252da /README.md
parent135ad6510353bfb50497157a03b2fe7aab5f78d4 (diff)
downloadsdl_core-16a885d3abd39d1129325bc7a91edba83ef3034e.tar.gz
Added documentation download links to README
Basically a hotfix until we can provide a more comprehensive developer portal
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index f532caab57..4dbdd440aa 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,12 @@ SmartDeviceLink is a way to connect applications on a smart phone to a vehicle s
Pull Requests Welcome!
+## Documentation
+
+ * [Software Architecture Document](https://app.box.com/s/v5ymu5kathzkwfx8iigxxdpr7d5a2xhh)
+ * [Transport Manager Programming Guide](https://app.box.com/s/1pjquttvmhf19uujtw4x4fv4t1leqasa)
+ * [Software Detailed Design](https://app.box.com/s/ohgrvemtx39f8hfea1ab676xxrzvyx1y)
+
## SDL Core
The Core component of SDL is meant to run on a vehicle's computing system. It connects to a consumer's smartphone over a variety of transports such as Bluetooth, USB, Android AOA, and TCP. Transport adapters can be written to extend the capabilities of Core's transport manager. Once a smartphone is connected over a preferred transport applications on the mobile phone that implement the mobile libraries can begin to communicate with the vehicle. First, the Core component queries the phone to understand which applications are compatible. The user interface shows the list of compatible applications to the driver. When the user selects an application, it is sent an HMI_STATUS level of FULL (all applications start with a BACKGROUND status). Once an application has the FULL status, it is allowed to populate a template, defined by the vehicle manufacturer, with content such as metadata, artwork, buttons and even supported grammars for voice commands (voice recognition engine not included).