README.md
1
2Android WatchFace Sample
3===================================
4
5A simple sample that demonstrates watch faces and complications for Wear 2.0.
6
7Introduction
8------------
9
10This sample demonstrates how to create watch faces for android wear and includes a phone app
11and a wearable app. The wearable app has a variety of watch faces including analog, digital,
12opengl, interactive, etc. It also includes a watch-side configuration example.
13The phone app includes a phone-side configuration example.
14
15The analog watch face demonstrates best practices for using complications in Wear 2.0. It also
16includes a configuration Activity for configuring the watch face styles and complications. We
17recommend you follow this UX pattern for your own watch faces.
18
19Because watch face apps do not have a default Activity in their project, you will need to set your
20Configurations to "Do not launch Activity" for both the Wear and Application modules. If you are
21unsure how to do this, please review the "Run Starter project" section in the
22[Google Watch Face Code Lab][1].
23
24[1]: https://codelabs.developers.google.com/codelabs/watchface/index.html
25
26Pre-requisites
27--------------
28
29- Android SDK 25
30- Android Build Tools v25.0.3
31- Android Support Repository
32
33Screenshots
34-------------
35
36<img src="screenshots/analog-face.png" height="400" alt="Screenshot"/> <img src="screenshots/analog-watch-side-config-1.png" height="400" alt="Screenshot"/> <img src="screenshots/analog-watch-side-config-2.png" height="400" alt="Screenshot"/> <img src="screenshots/digital-face.png" height="400" alt="Screenshot"/> <img src="screenshots/digital-phone-side-config.png" height="400" alt="Screenshot"/> <img src="screenshots/digital-watch-side-config.png" height="400" alt="Screenshot"/> <img src="screenshots/interactive-face.png" height="400" alt="Screenshot"/> <img src="screenshots/tilt-face.png" height="400" alt="Screenshot"/>
37
38Getting Started
39---------------
40
41This sample uses the Gradle build system. To build this project, use the
42"gradlew build" command or use "Import Project" in Android Studio.
43
44Support
45-------
46
47- Google+ Community: https://plus.google.com/communities/105153134372062985968
48- Stack Overflow: http://stackoverflow.com/questions/tagged/android
49
50If you've found an error in this sample, please file an issue:
51https://github.com/googlesamples/android-WatchFace
52
53Patches are encouraged, and may be submitted by forking this project and
54submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
55
56License
57-------
58
59Copyright 2017 The Android Open Source Project, Inc.
60
61Licensed to the Apache Software Foundation (ASF) under one or more contributor
62license agreements. See the NOTICE file distributed with this work for
63additional information regarding copyright ownership. The ASF licenses this
64file to you under the Apache License, Version 2.0 (the "License"); you may not
65use this file except in compliance with the License. You may obtain a copy of
66the License at
67
68http://www.apache.org/licenses/LICENSE-2.0
69
70Unless required by applicable law or agreed to in writing, software
71distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
72WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
73License for the specific language governing permissions and limitations under
74the License.
75
