diff --git a/info/ReadMe b/info/ReadMe index f13e6133bf..6a1412a051 100644 --- a/info/ReadMe +++ b/info/ReadMe @@ -1,7 +1,7 @@ UPDATE 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/ +* 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/ -- And perform generation using gradle `generateFullDoc` and `generateAvailableRules` contained in /IdeaProjects/diktat/info/build.gradle.kts +* After the updates you **need to perform generation** using gradle `generateFullDoc` and `generateAvailableRules` contained in /IdeaProjects/diktat/info/build.gradle.kts -- You do not need to change the contents of the diktat-coding-convention file +* You **do not need to change** the contents of the diktat-coding-convention file