Skip to content

Commit 58bfe53

Browse files
committed
Updated README.md for ktlint and detekt terminal command samples
1 parent 5c16af1 commit 58bfe53

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,15 @@ Git Hooks allow running a pre commit script to make sure the code complies with
7777

7878
This template is using [**ktlint**](https://github.com/pinterest/ktlint) with the [ktlint-gradle](https://github.com/jlleitschuh/ktlint-gradle) plugin to format your code. To reformat all the source code as well as the buildscript you can run the `ktlintFormat` gradle task.
7979

80+
Run `./gradlew ktlintCheck` to check if the there are any lint issues.
81+
82+
Run `./gradlew ktlintFormat` to format the code across the project.
83+
8084
This template is using [**detekt**](https://github.com/detekt/detekt) to analyze the source code, with the configuration that is stored in the [config.yml](.detekt/config.yml) file (the file has been generated with the `detektGenerateConfig` task).
8185

82-
Run `scripts/process-code.sh` to fix the code style and update the copyright.
86+
Run `./gradlew detekt` to analyze the code.
87+
88+
Alternatively, you can Run `scripts/process-code.sh` to fix the code style and update the copyright all at once.
8389

8490
## Code Formatting
8591

0 commit comments

Comments
 (0)