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