README.md
1
2Android WearComplicationProvidersTestSuite Sample
3===================================
4
5Complication Test Suite is a set of complication providers that provide dummy data and it can be
6used to test how different types of complications render on a watch face.
7
8Introduction
9------------
10
11Steps for trying out the sample:
12* Compile and install the wearable app onto your Wear device or emulator (for Wear scenario).
13
14* This sample does not have a main Activity (just Services that provide the complication data).
15Therefore, you may see an error next to the 'Run' button. To fix, click on the
16"Wearable" dropdown next to the 'Run' button and select 'Edit Configurations'. Under the
17'Launch Options', change the 'Launch' field from 'Default APK' to 'Nothing' and save.
18
19This sample provides dummy data for testing the complications UI in your watch face. After
20selecting a type from your watch face configuration Activity, you can tap on the complications to
21see more options.
22
23The Wear app demonstrates the use of [ComplicationData][1], [ComplicationManager][2],
24[ComplicationProviderService][3], [ComplicationText][4], and [ProviderUpdateRequester][5].
25
26[1]: https://developer.android.com/reference/android/support/wearable/complications/ComplicationData.html
27[2]: https://developer.android.com/reference/android/support/wearable/complications/ComplicationManager.html
28[3]: https://developer.android.com/reference/android/support/wearable/complications/ComplicationProviderService.html
29[4]: https://developer.android.com/reference/android/support/wearable/complications/ComplicationText.html
30[5]: https://developer.android.com/reference/android/support/wearable/complications/ProviderUpdateRequester.html
31
32Pre-requisites
33--------------
34
35- Android SDK 27
36- Android Build Tools v27.0.2
37- Android Support Repository
38
39Screenshots
40-------------
41
42<img src="screenshots/wear-1.png" height="400" alt="Screenshot"/> <img src="screenshots/wear-2.png" height="400" alt="Screenshot"/>
43
44Getting Started
45---------------
46
47This sample uses the Gradle build system. To build this project, use the
48"gradlew build" command or use "Import Project" in Android Studio.
49
50Support
51-------
52
53- Google+ Community: https://plus.google.com/communities/105153134372062985968
54- Stack Overflow: http://stackoverflow.com/questions/tagged/android
55
56If you've found an error in this sample, please file an issue:
57https://github.com/googlesamples/android-WearComplicationProvidersTestSuite
58
59Patches are encouraged, and may be submitted by forking this project and
60submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
61
62License
63-------
64
65Copyright 2017 The Android Open Source Project, Inc.
66
67Licensed to the Apache Software Foundation (ASF) under one or more contributor
68license agreements. See the NOTICE file distributed with this work for
69additional information regarding copyright ownership. The ASF licenses this
70file to you under the Apache License, Version 2.0 (the "License"); you may not
71use this file except in compliance with the License. You may obtain a copy of
72the License at
73
74http://www.apache.org/licenses/LICENSE-2.0
75
76Unless required by applicable law or agreed to in writing, software
77distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
78WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
79License for the specific language governing permissions and limitations under
80the License.
81
