From d13818045c0ecbfdaab828e94fb7f9a3615aad0e Mon Sep 17 00:00:00 2001 From: Richard Wise Date: Thu, 17 Dec 2020 11:49:21 +0800 Subject: [PATCH] Add clarification for IDEA setup in README To clarify how the IntelliJ IDEA code style setting configuration process works, add an brief explanation about what each command does and clarify that the code samples are command line calls, not config file entries --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7e9539e02e..f94b3c2319 100644 --- a/README.md +++ b/README.md @@ -354,6 +354,9 @@ val ktlintFormat by tasks.creating(JavaExec::class) { ##### Option #1 (recommended) +To change the code style config files in a single IDEA project + +Run ktlint executable with the appropriate flag: > (inside project's root directory) ```sh @@ -364,7 +367,9 @@ ktlint --android applyToIDEAProject ##### Option #2 -Apply to all IDEA projects: +To change the code style config files for all IDEA projects + +Run ktlint executable with the appropriate flag: ```sh ktlint applyToIDEA ```