README.md.ftl
1 Android ${sample.name} Sample
2 ===================================
3
4 <#if sample.metadata.description?is_node>
5 ${sample.metadata.description?trim?replace('\\n\\n', '\n')?replace('\\"', '"')?replace('\t+', '', 'r')?replace('(^\n+|\n+$)', '', 'r')}
6 <#else>
7 ${sample.strings.intro?trim?replace('\\n\\n', '\n')?replace('\\"', '"')?replace('\t+', '', 'r')?replace(' +', '', 'r')?replace("\\\\'", "'", 'r')?replace('\\"', '"', 'r')?replace('(^\n+|\n+$)', '', 'r')}
8 </#if><#if sample.metadata.intro?is_node>
9
10 Introduction
11 ------------
12
13 ${sample.metadata.intro?trim?replace('\\n\\n', '\n')?replace('\\"', '"')?replace('\t+', '', 'r')?replace('(^\n+|\n+$)', '', 'r')}
14 </#if>
15
16 Pre-requisites
17 --------------
18
19 <#-- Use the compile_sdk variable as the required SDK. For Preview SDKs, skip the 'v' and 'android-' prefixes in the output. -->
20 - Android SDK ${compile_sdk?is_number?string('v','')}${compile_sdk?replace('"', '', 'r')?replace('android-','Preview ')}
21 - Android Build Tools v${build_tools_version?replace('"', '', 'r')}
22 - Android Support Repository
23 <#if sample.metadata.screenshots?has_content>
24
25 Screenshots
26 -------------
27
28 <#list sample.metadata.screenshots.img as img><img src="${img}" height="400" alt="Screenshot"/> </#list>
29 </#if>
30
31 Getting Started
32 ---------------
33
34 This sample uses the Gradle build system. To build this project, use the
35 "gradlew build" command or use "Import Project" in Android Studio.
36
37 Support
38 -------
39
40 - Google+ Community: https://plus.google.com/communities/105153134372062985968
41 - Stack Overflow: http://stackoverflow.com/questions/tagged/android
42
43 If you've found an error in this sample, please file an issue:
44 https://github.com/googlesamples/android-${sample.name}
45
46 Patches are encouraged, and may be submitted by forking this project and
47 submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
48
49 License
50 -------
51
52 Copyright 2019 The Android Open Source Project, Inc.
53
54 Licensed to the Apache Software Foundation (ASF) under one or more contributor
55 license agreements. See the NOTICE file distributed with this work for
56 additional information regarding copyright ownership. The ASF licenses this
57 file to you under the Apache License, Version 2.0 (the "License"); you may not
58 use this file except in compliance with the License. You may obtain a copy of
59 the License at
60
61 http://www.apache.org/licenses/LICENSE-2.0
62
63 Unless required by applicable law or agreed to in writing, software
64 distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
65 WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
66 License for the specific language governing permissions and limitations under
67 the License.
68