Skip to content

Commit d9204b4

Browse files
authored
update doc to emphasize on asset folder (#644)
1 parent 4d0d557 commit d9204b4

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

samples/Android/README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ to run the following [samples](#links-to-individual-sample-readme-files) from aw
1919

2020

2121
# Prerequisites
22-
The individual samples within the app require specific files to operate. The files must be placed in the
23-
`app/src/main/assets` directory prior to building for the sample app to connect to IoT Core and complete
24-
succesfully. The names of the files must be exactly as provided. Explanations for what each file and
22+
The individual samples within the app require specific files to operate. The files **MUST** be placed in the
23+
**`app/src/main/assets`** directory prior to building for the sample app to connect to IoT Core and complete
24+
successfully. The names of the files must be exactly as provided. Explanations for what each file and
2525
associated argument are doing can be found in the individual [Sample README](#links-to-individual-sample-readme-files)
2626
files linked below.
2727

@@ -86,4 +86,9 @@ Android sample app.
8686

8787
[**CognitoConnect**](../CognitoConnect/README.md)
8888

89-
##### NOTE: The shadow sample does not currently complete on android due to its dependence on stdin keyboard input.
89+
##### NOTE: The shadow sample does not currently complete on android due to its dependence on stdin keyboard input.
90+
91+
92+
# Trouble Shooting
93+
### Error: The file name must end with .xml
94+
This error typically occurs when non-XML files are placed in the `app/src/main/res/` directory. Android enforces strict rules on what can be included in the `res/` folder. If you're working with test or data files (e.g., .txt in our sample), you **MUST** place them in the `app/src/main/assets/` directory instead.

0 commit comments

Comments
 (0)