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