Skip to content

Commit

Permalink
### Whats added:
Browse files Browse the repository at this point in the history
 * Add ReadMe in Info - contains a guide for updating `codestyle` in main `readme`

### Issue(#1384)
  • Loading branch information
Arrgentum committed Jun 21, 2022
1 parent 3814cd8 commit 4cfdaad
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion info/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 4cfdaad

Please sign in to comment.