diff options
Diffstat (limited to 'android/README.md')
| -rw-r--r-- | android/README.md | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/android/README.md b/android/README.md index 92c1832f74..57e428eaa7 100644 --- a/android/README.md +++ b/android/README.md @@ -40,8 +40,18 @@ Also, see the [`ktfmt` gradle plugin documentation](https://github.com/cortinico how to use it as a gradle task. ### XML formatting -`tidy` is used for XML resource formatting. `tidy` is a separate tool which has to be installed -unless the container image (which includes `tidy`) is used. +In order to format XML files, the script `scripts/tidy.sh` is used. As the script name implies, it's basically a helper script to run the tool called `tidy`. It needs to be installed unless the +container image is used. + +Command to format: +``` +scripts/tidy.sh format +``` + +Command to format and check for any changes: +``` +scripts/tidy.sh formatAndCheckDiff +``` ### Android Gradle Plugin lint tool |