From 4cfdaada98b6d5ab361761c278f1a58cb935c2f2 Mon Sep 17 00:00:00 2001 From: Arrgentum Date: Tue, 21 Jun 2022 18:01:14 +0300 Subject: [PATCH] ### Whats added: * Add ReadMe in Info - contains a guide for updating `codestyle` in main `readme` ### Issue(#1384) --- info/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/info/README.md b/info/README.md index 284670ee54..8cfe38176e 100644 --- a/info/README.md +++ b/info/README.md @@ -2,6 +2,6 @@ UPDATE MAIN README * To update the code style text in the main README, you **NEED TO CHANGE** the contents of the file `guide-chapter-n.md` , the paragraph in which you added/changed the rule contained in `/IdeaProjects/diktat/info/`. -* After the updates you **NEED TO PERFORM GENERATION** using gradle `generateFullDoc` and `generateAvailableRules` contained in `/IdeaProjects/diktat/info/build.gradle.kts`. Example - ` . gradlew :generateFullDoc --continuous` and ` . gradlew :generateAvailableRules --continuous`. +* After the updates you **NEED TO PERFORM GENERATION** using gradle `generateFullDoc` and `generateAvailableRules` contained in `/IdeaProjects/diktat/info/build.gradle.kts` file. Example - ` . gradlew :generateFullDoc --continuous` and ` . gradlew :generateAvailableRules --continuous`. * You **DO NOT NEED TO CHANGE** the contents of the `diktat-coding-convention` file.