Bugfix/corrected readme (#1384)

### Whats added: * Add ReadMe in Info - contains a guide for updating `codestyle` in main `readme` * Corrected code style in guide-chapter-3.md ### Issue(#1381)
saveourtool · Jun 22, 2022 · 79a55c8 · 79a55c8
1 parent a34c513
commit 79a55c8
Show file tree

Hide file tree

Showing 3 changed files with 592 additions and 299 deletions.
diff --git a/info/README.md b/info/README.md
@@ -0,0 +1,13 @@
+# UPDATE THE MAIN [README.md](../README.md)
+
+#### To update the codestyle text in the main [README.md](../README.md):
+
+* You **NEED TO CHANGE** the content of the file `guide-chapter-<N>.md`, contained in `info/guide`, the corresponding section of the rules that you changed / added.
+
+* ```console
+  $ cd info/
+  $ ./gradlew :generateFullDoc
+  $ ./gradlew :generateAvailableRules
+  ```
+
+#### You **DO NOT NEED TO CHANGE** the content of the [`diktat-coding-convention.md`](guide/diktat-coding-convention.md) file.